FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/EHDSSubstanceUse

Packageeu.ehds.models
TypeStructureDefinition
IdEHDSSubstanceUse
FHIR VersionR5
Sourcehttps://www.xt-ehr.eu/specifications/fhir/https://build.fhir.org/ig/Xt-EHR/xt-ehr-common/StructureDefinition-EHDSSubstanceUse.html
URLhttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSubstanceUse
Version0.1.0
Statusdraft
Date2025-07-22T10:29:12+00:00
NameEHDSSubstanceUse
TitleSubstance use model
DescriptionStatement about using a substance (such as tobacco, alcohol, drugs, etc).
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSubstanceUse
Kindlogical

Resources that use this resource

StructureDefinition
EHDSDischargeReportDischarge Report model

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..*EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Substance use model
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
... period 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).
.... period 0..1PeriodTime period of alcohol 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

Source

{
  "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": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSubstanceUse",
  "version": "0.1.0",
  "name": "EHDSSubstanceUse",
  "title": "Substance use model",
  "status": "draft",
  "date": "2025-07-22T10:29:12+00:00",
  "publisher": "Xt-EHR",
  "contact": [
    {
      "name": "Xt-EHR",
      "telecom": [
        {
          "system": "url",
          "value": "http://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": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSSubstanceUse",
  "baseDefinition": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDataSet",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "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": "Common header for all patient-related data",
        "definition": "Common header for all patient-related data",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.subject",
        "path": "EHDSSubstanceUse.header.subject",
        "short": "Subject",
        "definition": "Patient/subject information",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.subject",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.identifier",
        "path": "EHDSSubstanceUse.header.identifier",
        "short": "Business identifier for the object",
        "definition": "Business identifier for the object",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDataSet.header.identifier",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.authorship",
        "path": "EHDSSubstanceUse.header.authorship",
        "short": "Authorship",
        "definition": "Resource authoring details",
        "min": 1,
        "max": "*",
        "base": {
          "path": "EHDSDataSet.header.authorship",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "Base"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.authorship.author[x]",
        "path": "EHDSSubstanceUse.header.authorship.author[x]",
        "short": "Author",
        "definition": "Author(s) by whom the resource was/were authored. Multiple authors could be provided.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.authorship.author[x]",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional"
          },
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation"
          },
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.authorship.datetime",
        "path": "EHDSSubstanceUse.header.authorship.datetime",
        "short": "Date and time of authoring/issuing",
        "definition": "Date and time of the issuing the document/resource by its author.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.authorship.datetime",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.lastUpdate",
        "path": "EHDSSubstanceUse.header.lastUpdate",
        "short": "Date and time of the last update to the resource",
        "definition": "Date and time of the last update to the document/information",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.lastUpdate",
          "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",
        "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.statusReason[x]",
        "path": "EHDSSubstanceUse.header.statusReason[x]",
        "short": "Reason for the current status of the resource.",
        "definition": "Reason for the current status of the resource.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.statusReason[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          },
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.header.language",
        "path": "EHDSSubstanceUse.header.language",
        "short": "Language",
        "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.header.version",
        "path": "EHDSSubstanceUse.header.version",
        "short": "Version",
        "definition": "Business version of the resource.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSDataSet.header.version",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.presentedForm",
        "path": "EHDSSubstanceUse.presentedForm",
        "short": "A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document",
        "definition": "A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSDataSet.presentedForm",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment"
          }
        ]
      },
      {
        "id": "EHDSSubstanceUse.period",
        "path": "EHDSSubstanceUse.period",
        "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.period",
          "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.period",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.period",
        "short": "Time period of alcohol use.",
        "definition": "Time period of alcohol use.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSSubstanceUse.frequencyAndQuantity.period",
          "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.period",
        "path": "EHDSSubstanceUse.period",
        "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.period",
        "path": "EHDSSubstanceUse.frequencyAndQuantity.period",
        "short": "Time period of alcohol use.",
        "definition": "Time period of alcohol 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"
          }
        ]
      }
    ]
  }
}