FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagextehr.eu.ehds.models
Resource TypeStructureDefinition
IdStructureDefinition-EHDSSubstanceUse.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/Xt-EHR/xt-ehr-common/StructureDefinition-EHDSSubstanceUse.html
URLhttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSSubstanceUse
Version0.2.1
Statusdraft
Date2026-02-04T19:00:50+00:00
NameEHDSSubstanceUse
TitleSubstance use model
DescriptionStatement about using a substance (such as tobacco, alcohol, drugs, etc).
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSSubstanceUse
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
EHDSDataSetDataSet model

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition EHDSSubstanceUse

NameFlagsCard.TypeDescription & Constraintsdoco
.. EHDSSubstanceUse 0..*EHDSDataSetSubstance use model

Elements defined in Ancestors:header
Instances of this logical model can be the target of a Reference
... header
.... status 1..1CodeableConceptStatus of the patient’s alcohol use.
Binding Description: (preferred): SNOMED CT
... observationPeriod 0..1PeriodTime period for which this observation about substance use is applicable
... frequencyAndQuantity 0..1BaseThe extent of the patient’s alcohol use in units of alcohol per time period.
.... quantity 1..1QuantityQuantity (volume per time unit).
.... periodOfUse 0..1PeriodTime period of substance use.
... substanceType 0..1CodeableConceptType of substance
Binding Description: (preferred): SNOMED CT
... routeOfAdministration 0..*CodeableConceptRoute(s) of administration
Binding Description: (preferred): EDQM
... note 0..1stringTextual comment.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "EHDSSubstanceUse",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    }
  ],
  "url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSSubstanceUse",
  "version": "0.2.1",
  "name": "EHDSSubstanceUse",
  "title": "Substance use model",
  "status": "draft",
  "date": "2026-02-04T19:00:50+00:00",
  "publisher": "Xt-EHR",
  "contact": [
    {
      "name": "Xt-EHR",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.xt-ehr.eu/"
        }
      ]
    }
  ],
  "description": "Statement about using a substance (such as tobacco, alcohol, drugs, etc).",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSSubstanceUse",
  "baseDefinition": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDataSet",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.2.1"
      }
    ],
    "element": [
      {
        "id": "EHDSSubstanceUse",
        "path": "EHDSSubstanceUse",
        "short": "Substance use model",
        "definition": "Statement about using a substance (such as tobacco, alcohol, drugs, etc).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header",
        "path": "EHDSSubstanceUse.header",
        "short": "Basic metadata for this information",
        "definition": "Basic metadata for this information",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.subject",
        "path": "EHDSSubstanceUse.header.subject",
        "short": "Patient/subject information",
        "definition": "Patient/subject information",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.subject",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.identifier",
        "path": "EHDSSubstanceUse.header.identifier",
        "short": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
        "definition": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDataSet.header.identifier",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.author[x]",
        "path": "EHDSSubstanceUse.header.author[x]",
        "short": "Author(s) responsible for the provided information.",
        "definition": "Author(s) responsible for the provided information. The exact role of the responsible author varies across use cases and is specific to individual models.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDataSet.header.author[x]",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
          },
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
          },
          {
            "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.date",
        "path": "EHDSSubstanceUse.header.date",
        "short": "Date and optionally time of authoring/issuing",
        "definition": "Date and optionally time of authoring/issuing",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.date",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.status",
        "path": "EHDSSubstanceUse.header.status",
        "short": "Status of the patient’s alcohol use.",
        "definition": "Status of the resource or document",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "SNOMED CT"
        }
      },
      {
        "id": "EHDSSubstanceUse.header.source",
        "path": "EHDSSubstanceUse.header.source",
        "short": "Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.",
        "definition": "Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.source",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.language",
        "path": "EHDSSubstanceUse.header.language",
        "short": "Language in which the resource is written. Language is expressed by the IETF language tag.",
        "definition": "Language in which the resource is written. Language is expressed by the IETF language tag.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.language",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "BCP 47"
        }
      },
      {
        "id": "EHDSSubstanceUse.observationPeriod",
        "path": "EHDSSubstanceUse.observationPeriod",
        "short": "Time period for which this observation about substance use is applicable",
        "definition": "Time period for which this observation about substance use is applicable",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.observationPeriod",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity",
        "path": "EHDSSubstanceUse.frequencyAndQuantity",
        "short": "The extent of the patient’s alcohol use in units of alcohol per time period.",
        "definition": "The extent of the patient’s alcohol use in units of alcohol per time period.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.frequencyAndQuantity",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity.quantity",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.quantity",
        "short": "Quantity (volume per time unit).",
        "definition": "Quantity (volume per time unit).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.frequencyAndQuantity.quantity",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity.periodOfUse",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.periodOfUse",
        "short": "Time period of substance use.",
        "definition": "Time period of substance use.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.frequencyAndQuantity.periodOfUse",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.substanceType",
        "path": "EHDSSubstanceUse.substanceType",
        "short": "Type of substance",
        "definition": "Type of substance",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.substanceType",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "SNOMED CT"
        }
      },
      {
        "id": "EHDSSubstanceUse.routeOfAdministration",
        "path": "EHDSSubstanceUse.routeOfAdministration",
        "short": "Route(s) of administration",
        "definition": "Route(s) of administration",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSSubstanceUse.routeOfAdministration",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "EDQM"
        }
      },
      {
        "id": "EHDSSubstanceUse.note",
        "path": "EHDSSubstanceUse.note",
        "short": "Textual comment.",
        "definition": "Textual comment.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.note",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "EHDSSubstanceUse",
        "path": "EHDSSubstanceUse",
        "short": "Substance use model",
        "definition": "Statement about using a substance (such as tobacco, alcohol, drugs, etc)."
      },
      {
        "id": "EHDSSubstanceUse.header.status",
        "path": "EHDSSubstanceUse.header.status",
        "short": "Status of the patient’s alcohol use.",
        "binding": {
          "strength": "preferred",
          "description": "SNOMED CT"
        }
      },
      {
        "id": "EHDSSubstanceUse.observationPeriod",
        "path": "EHDSSubstanceUse.observationPeriod",
        "short": "Time period for which this observation about substance use is applicable",
        "definition": "Time period for which this observation about substance use is applicable",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity",
        "path": "EHDSSubstanceUse.frequencyAndQuantity",
        "short": "The extent of the patient’s alcohol use in units of alcohol per time period.",
        "definition": "The extent of the patient’s alcohol use in units of alcohol per time period.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity.quantity",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.quantity",
        "short": "Quantity (volume per time unit).",
        "definition": "Quantity (volume per time unit).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.frequencyAndQuantity.periodOfUse",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.periodOfUse",
        "short": "Time period of substance use.",
        "definition": "Time period of substance use.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.substanceType",
        "path": "EHDSSubstanceUse.substanceType",
        "short": "Type of substance",
        "definition": "Type of substance",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "SNOMED CT"
        }
      },
      {
        "id": "EHDSSubstanceUse.routeOfAdministration",
        "path": "EHDSSubstanceUse.routeOfAdministration",
        "short": "Route(s) of administration",
        "definition": "Route(s) of administration",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "EDQM"
        }
      },
      {
        "id": "EHDSSubstanceUse.note",
        "path": "EHDSSubstanceUse.note",
        "short": "Textual comment.",
        "definition": "Textual comment.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}