FHIR IG Statistics: StructureDefinition/cio-SurveillanceDecision

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "cio-SurveillanceDecision",
  "url": "http://nictiz.nl/fhir/StructureDefinition/cio-SurveillanceDecision",
  "version": "1.0.0-beta.5",
  "name": "CioSurveillanceDecision",
  "title": "cio SurveillanceDecision",
  "status": "draft",
  "publisher": "Nictiz",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "The decision to initiate or terminate surveillance for a substance or group of substances that may cause an adverse reaction in the patient.",
  "purpose": "This Flag resource represents the SurveillanceDecision building block for implementations following the information standard [CiO](https://informatiestandaarden.nictiz.nl/wiki/Landingspagina_Contra-indicaties_en_Overgevoeligheden). This profile is based on the Dutch zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) SurveillanceDecision that is part of the 2024 prepublication. Therefore it has no dependency on a corresponding nl-core profile and mappings to zib concepts are not defined. Instead mappings to the CiO data set have been added. It is the intention to derive this profile from a more general nl-core-SurveillanceDecision profile in the future.",
  "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": "cio-dataset-200-beta2-20231214",
      "uri": "https://decor.nictiz.nl/pub/cio/cio-html-20231214T100742/ds-2.16.840.1.113883.2.4.3.11.60.26.1.2-2020-04-02T000000.html",
      "name": "ART-DECOR Dataset Contraindications and hypersensitivities 2.0.0-beta.2 20231214"
    },
    {
      "identity": "cio-dataset-200-beta3-20241023",
      "uri": "https://decor.nictiz.nl/pub/cio/cio-html-20241023T071643/ds-2.16.840.1.113883.2.4.3.11.60.26.1.2-2020-04-02T000000.html",
      "name": "ART-DECOR Dataset Contraindications and hypersensitivities 2.0.0-beta.3 20241023"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Flag",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Flag",
        "path": "Flag",
        "short": "SurveillanceDecision",
        "comment": "In order to convey the registration information of a SurveillanceDecision building block, this profile is used together with an instance conforming to the [cio-RegistrationInformation](http://nictiz.nl/fhir/StructureDefinition/cio-RegistrationInformation) profile wherein `Provenance.target` refers to the Flag resource.\r\n\r\nNote that not all concepts within the SurveillanceDecision building block are mapped to elements within this profile (e.g. DecisionMaker (cio-dataelement-20-763)). To convey the complete SurveillanceDecision building block, a Flag resource conforming to this profile SHOULD always be used together with an instance conforming to the cio-RegistrationInformation profile.",
        "alias": [
          "BewakingBesluit"
        ],
        "constraint": [
          {
            "key": "cio-SurveillanceDecision-1",
            "severity": "error",
            "human": "If Flag.status is 'inactive', Flag.period.end SHALL exist.",
            "expression": "(status = 'inactive') implies period.end.exists()"
          },
          {
            "key": "cio-SurveillanceDecision-2",
            "severity": "error",
            "human": "If the surveillance is stopped (i.e. Flag.status is 'inactive'), a reference to the previous surveillance decision that was active SHALL be present in Flag.extension:relationSurveillanceDecision.",
            "expression": "(status = 'inactive') implies extension('http://nictiz.nl/fhir/StructureDefinition/ext-SurveillanceDecision.RelationSurveillanceDecision').exists()"
          },
          {
            "key": "cio-SurveillanceDecision-3",
            "severity": "error",
            "human": "A decision basis SHALL be given, either as a reference to a hypersensitivity/intolerance or reaction in Flag.extension:decisionBasisReference, or as text in Flag.extension:decisionBasisReason.",
            "expression": "extension('http://hl7.org/fhir/StructureDefinition/flag-detail').exists() or extension('http://nictiz.nl/fhir/StructureDefinition/ext-SurveillanceDecision.SurveillanceDecision').exists()"
          }
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-754",
            "comment": "SurveillanceDecision"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-754",
            "comment": "SurveillanceDecision"
          }
        ]
      },
      {
        "id": "Flag.extension",
        "path": "Flag.extension",
        "min": 1
      },
      {
        "id": "Flag.extension:decisionBasisReference",
        "path": "Flag.extension",
        "sliceName": "decisionBasisReference",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/flag-detail"
            ]
          }
        ],
        "condition": [
          "cio-SurveillanceDecision-3"
        ]
      },
      {
        "id": "Flag.extension:decisionBasisReference.value[x]",
        "path": "Flag.extension.value[x]",
        "short": "HypersensitivityIntolerance / Reaction",
        "definition": "The hypersensitivity/intolerance or reaction in the patient as reason for the surveillance decision.",
        "comment": "Whenever the surveillance decision has been taken on another basis than a hypersensitivity/intolerance or reaction, that basis SHALL be communicated via `.extension:decisionBasisReason`.",
        "alias": [
          "Overgevoeligheid",
          "Reactie"
        ],
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://nictiz.nl/fhir/StructureDefinition/cio-HypersensitivityIntolerance",
              "http://nictiz.nl/fhir/StructureDefinition/cio-Reaction"
            ]
          }
        ],
        "condition": [
          "cio-SurveillanceDecision-3"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-765",
            "comment": "Hypersensitivity [DEPRECATED]"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-765",
            "comment": "HypersensitivityIntolerance"
          },
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-766",
            "comment": "Reaction"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-766",
            "comment": "Reaction"
          }
        ]
      },
      {
        "id": "Flag.extension:decisionBasisReason",
        "path": "Flag.extension",
        "sliceName": "decisionBasisReason",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-SurveillanceDecision.SurveillanceDecision"
            ]
          }
        ],
        "condition": [
          "cio-SurveillanceDecision-3"
        ]
      },
      {
        "id": "Flag.extension:decisionBasisReason.value[x]",
        "path": "Flag.extension.value[x]",
        "comment": "Whenever the surveillance decision has been taken on another basis than a hypersensitivity/intolerance or reaction, that basis SHALL be communicated via this element.",
        "condition": [
          "cio-SurveillanceDecision-3"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-916",
            "comment": "SurveillanceDecision"
          }
        ]
      },
      {
        "id": "Flag.extension:relationSurveillanceDecision",
        "path": "Flag.extension",
        "sliceName": "relationSurveillanceDecision",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-SurveillanceDecision.RelationSurveillanceDecision"
            ]
          }
        ],
        "condition": [
          "cio-SurveillanceDecision-2"
        ]
      },
      {
        "id": "Flag.extension:relationSurveillanceDecision.value[x]",
        "path": "Flag.extension.value[x]",
        "condition": [
          "cio-SurveillanceDecision-2"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-828",
            "comment": "RelationSurveillanceDecision"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-828",
            "comment": "RelationSurveillanceDecision"
          }
        ]
      },
      {
        "id": "Flag.extension:comment",
        "path": "Flag.extension",
        "sliceName": "comment",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
            ]
          }
        ]
      },
      {
        "id": "Flag.extension:comment.value[x]",
        "path": "Flag.extension.value[x]",
        "short": "Comment",
        "definition": "Textual explanation of the surveillance decision which cannot be expressed in any of the other fields.",
        "alias": [
          "Toelichting"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-764",
            "comment": "Comment [DEPRECATED]"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-764",
            "comment": "Comment"
          }
        ]
      },
      {
        "id": "Flag.extension:medicationHypersensitivityIdentifier",
        "path": "Flag.extension",
        "sliceName": "medicationHypersensitivityIdentifier",
        "min": 1,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationHypersensitivity.Identifier"
            ]
          }
        ]
      },
      {
        "id": "Flag.extension:medicationHypersensitivityIdentifier.value[x]",
        "path": "Flag.extension.value[x]",
        "mapping": [
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-888",
            "comment": "IdentificationGMO"
          }
        ]
      },
      {
        "id": "Flag.identifier",
        "path": "Flag.identifier",
        "short": "IdentificationNumber",
        "definition": "Globally unique number that identifies the instantiation of the information model. The number is composed of an identification of the issuer organization and a unique number assigned by this organization.",
        "alias": [
          "Identificatienummer"
        ],
        "min": 1,
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-780",
            "comment": "IdentificationNumber"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-780",
            "comment": "IdentificationNumber"
          }
        ]
      },
      {
        "id": "Flag.status",
        "path": "Flag.status",
        "comment": "Sending systems that don't record an explicit status, SHOULD use the following guidance to infer a value from DecisionType:\r\n\r\n* When the value of DecisionType is _385652002_, `.status` will be set to _active_.\r\n* When the value of DecisionType is _410546004_, `.status` will be set to _inactive_.",
        "condition": [
          "cio-SurveillanceDecision-1",
          "cio-SurveillanceDecision-2"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-755",
            "comment": "DecisionType (implicit)"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-755",
            "comment": "DecisionType (implicit)"
          }
        ]
      },
      {
        "id": "Flag.category",
        "path": "Flag.category",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Flag.category:surveillanceDecisionCode",
        "path": "Flag.category",
        "sliceName": "surveillanceDecisionCode",
        "min": 1,
        "max": "1",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "225419007"
            }
          ]
        }
      },
      {
        "id": "Flag.code",
        "path": "Flag.code",
        "short": "UnsafeSubstance",
        "definition": "The substance or group of substances that must be monitored completely or with exceptions.",
        "comment": "The message that is be displayed to the user, should indicate the necessity of surveillance on the substance or group of substances present in the UnsafeSubstance concept with the exception of the substances indicated by the SafeWithinUnsafeGroup concept. Since it's semantically not possible to include the content of both concepts within `.code` (e.g. in different `.code.coding`s), the latter concept is represented by the `.extension:safeWithinUnsafeGroup` on `.code`, and the `.code.text` element SHOULD be used to convey the textual representation of the SubstanceForSurveillance concept as a whole. The `.code.text` could read for instance:\r\n* If UnsafeSubstance refers to a single substance:\r\n    * (English) 'Monitor the use of {UnsafeSubstance} as treatment for the patient, since this substance is unsafe for the patient.'\r\n    * (Dutch) 'Let op het gebruik van {UnsafeSubstance} als behandeling voor de patiënt, aangezien deze stof onveilig is voor de patiënt.'\r\n* If UnsafeSubstance refers to a group of substances, and there possibly are several substances specified within SafeWithinUnsafeGroup:\r\n    * (English) 'Monitor the use of {UnsafeSubstance} as treatment for the patient, since this group of substances is unsafe for the patient (with the exception of {SafeWithinUnsafeGroup}).'\r\n    * (Dutch) 'Let op het gebruik van {UnsafeSubstance} als behandeling voor de patiënt, aangezien deze groep van stoffen onveilig is voor de patiënt (met uitzondering van {SafeWithinUnsafeGroup}).'",
        "alias": [
          "OnveiligeStof"
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.26.11.27--20231129131119"
        },
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-761",
            "comment": "UnsafeSubstance"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-761",
            "comment": "UnsafeSubstance"
          }
        ]
      },
      {
        "id": "Flag.code.extension:safeWithinUnsafeGroup",
        "path": "Flag.code.extension",
        "sliceName": "safeWithinUnsafeGroup",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/ext-SurveillanceDecision.SafeWithinUnsafeGroup"
            ]
          }
        ]
      },
      {
        "id": "Flag.code.extension:safeWithinUnsafeGroup.value[x]",
        "path": "Flag.code.extension.value[x]",
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-762",
            "comment": "SafeWithinUnsafeGroup"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-762",
            "comment": "SafeWithinUnsafeGroup"
          }
        ]
      },
      {
        "id": "Flag.code.text",
        "path": "Flag.code.text",
        "comment": "For guidance on how to populate this element, see the comment on `.code`.",
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-760",
            "comment": "SubstanceForSurveillance (implicit)"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-760",
            "comment": "SubstanceForSurveillance (implicit)"
          }
        ]
      },
      {
        "id": "Flag.subject",
        "path": "Flag.subject",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient"
            ]
          }
        ]
      },
      {
        "id": "Flag.period",
        "path": "Flag.period",
        "min": 1
      },
      {
        "id": "Flag.period.start",
        "path": "Flag.period.start",
        "short": "DecisionEffectiveDateTime",
        "definition": "Moment (date and time) when the decision (of type 'start surveillance') should take effect.",
        "comment": "When the value of DecisionType is _385652002_ the DecisionEffectiveDateTime SHALL be mapped to `.period.start`. Whenever the DecisionType is _410546004_, the DecisionEffectiveDateTime SHALL be mapped to `.period.end`, and the `.period.start` SHALL not change (i.e. it should be the same as in the Flag resource that is referenced via `.extension:relationSurveillanceDecision`).",
        "alias": [
          "BesluitIngangsDatumTijd"
        ],
        "min": 1,
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-757",
            "comment": "DecisionEffectiveDateTime"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-757",
            "comment": "DecisionEffectiveDateTime"
          }
        ]
      },
      {
        "id": "Flag.period.end",
        "path": "Flag.period.end",
        "short": "DecisionEffectiveDateTime",
        "definition": "Moment (date and time) when the decision (of type 'discontinue surveillance') should take effect.",
        "comment": "When the value of DecisionType is _385652002_ the DecisionEffectiveDateTime SHALL be mapped to `.period.start`. Whenever the DecisionType is _410546004_, the DecisionEffectiveDateTime SHALL be mapped to `.period.end`, and the `.period.start` SHALL not change (i.e. it should be the same as in the Flag resource that is referenced via `.extension:relationSurveillanceDecision`).",
        "alias": [
          "BesluitIngangsDatumTijd"
        ],
        "condition": [
          "cio-SurveillanceDecision-1"
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-757",
            "comment": "DecisionEffectiveDateTime"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-757",
            "comment": "DecisionEffectiveDateTime"
          }
        ]
      },
      {
        "id": "Flag.author",
        "path": "Flag.author",
        "short": "Author",
        "definition": "The person who has registered or had someone else register the information in the patient record.",
        "alias": [
          "Auteur"
        ],
        "type": [
          {
            "code": "Reference",
            "profile": [
              "http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference"
            ],
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "cio-dataset-200-beta2-20231214",
            "map": "cio-dataelement-20-781",
            "comment": "Author"
          },
          {
            "identity": "cio-dataset-200-beta3-20241023",
            "map": "cio-dataelement-20-781",
            "comment": "Author"
          }
        ]
      }
    ]
  }
}