Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeAddiction

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-addiction
Version:1.2.2
Name:BeAddiction
Status:Active as of 2021-01-10T10:59:49+00:00
Definition:

A record of a patient's known, suspected or resolved addiction. This represents the addiction condition, not an addiction-related event or observation.

Publisher:eHealth
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-addiction

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Condition

This structure is derived from Condition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*ConditionDetailed information about conditions, problems or diagnoses
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-addiction-quantifier S0..1RatioExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-addiction-quantifier
... identifier S0..*IdentifierExternal Ids for this condition
... verificationStatus S0..1CodeableConceptThe verification status of the addiction - whether it is suspected, confirmed, etc.
... category S1..*CodeableConceptThe category of addiction, e.g. gaming, social, or substance addiction...
Binding: Addiction Category (extensible)
... code S1..1CodeableConceptThe specific addiction substance
Binding: Addiction Code (extensible)
... bodySite 0..0
... subject S1..1Reference(BePatient)The person that has/had the addiction
... onset[x] 0..1dateTime, Age, Period, Range, stringThe time, event or period when the addiction started. If it's a period, this is the period in which the addiction appeared, not how long the addiction lasted.
... abatement[x] 0..1dateTime, Age, Period, Range, stringThe time, event or period when the addiction ended.
... recordedDate 0..1dateTimeThe date when the addiction was first recorded
... recorder S0..1Reference(BePractitioner | BePractitionerRole | BePatient)The person that first recorded the addiction
... asserter S0..1Reference(BePractitioner | BePractitionerRole | BePatient | RelatedPerson)The person that asserted or informed about the addiction.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*ConditionDetailed information about conditions, problems or diagnoses
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-addiction-quantifier S0..1RatioExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-addiction-quantifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣI0..1CodeableConceptThe clinical status of the addiction - whether it is active, resolved...
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!SΣI0..1CodeableConceptThe verification status of the addiction - whether it is suspected, confirmed, etc.
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.

... category S1..*CodeableConceptThe category of addiction, e.g. gaming, social, or substance addiction...
Binding: Addiction Category (extensible)
... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code SΣ1..1CodeableConceptThe specific addiction substance
Binding: Addiction Code (extensible)
... subject SΣ1..1Reference(BePatient)The person that has/had the addiction
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... onset[x] Σ0..1The time, event or period when the addiction started. If it's a period, this is the period in which the addiction appeared, not how long the addiction lasted.
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... abatement[x] I0..1The time, event or period when the addiction ended.
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate Σ0..1dateTimeThe date when the addiction was first recorded
... recorder SΣ0..1Reference(BePractitioner | BePractitionerRole | BePatient)The person that first recorded the addiction
... asserter SΣ0..1Reference(BePractitioner | BePractitionerRole | BePatient | RelatedPerson)The person that asserted or informed about the addiction.
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*ConditionDetailed information about conditions, problems or diagnoses
... be-ext-addiction-quantifier 0..1RatioExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-addiction-quantifier
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!ΣI0..1CodeableConceptThe clinical status of the addiction - whether it is active, resolved...
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... category 1..*CodeableConceptThe category of addiction, e.g. gaming, social, or substance addiction...
Binding: Addiction Category (extensible)
... code Σ1..1CodeableConceptThe specific addiction substance
Binding: Addiction Code (extensible)
... subject Σ1..1Reference(BePatient)The person that has/had the addiction
... recorder Σ0..1Reference(BePractitioner | BePractitionerRole | BePatient)The person that first recorded the addiction
... asserter Σ0..1Reference(BePractitioner | BePractitionerRole | BePatient | RelatedPerson)The person that asserted or informed about the addiction.

doco Documentation for this format

This structure is derived from Condition

Differential View

This structure is derived from Condition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*ConditionDetailed information about conditions, problems or diagnoses
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-addiction-quantifier S0..1RatioExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-addiction-quantifier
... identifier S0..*IdentifierExternal Ids for this condition
... verificationStatus S0..1CodeableConceptThe verification status of the addiction - whether it is suspected, confirmed, etc.
... category S1..*CodeableConceptThe category of addiction, e.g. gaming, social, or substance addiction...
Binding: Addiction Category (extensible)
... code S1..1CodeableConceptThe specific addiction substance
Binding: Addiction Code (extensible)
... bodySite 0..0
... subject S1..1Reference(BePatient)The person that has/had the addiction
... onset[x] 0..1dateTime, Age, Period, Range, stringThe time, event or period when the addiction started. If it's a period, this is the period in which the addiction appeared, not how long the addiction lasted.
... abatement[x] 0..1dateTime, Age, Period, Range, stringThe time, event or period when the addiction ended.
... recordedDate 0..1dateTimeThe date when the addiction was first recorded
... recorder S0..1Reference(BePractitioner | BePractitionerRole | BePatient)The person that first recorded the addiction
... asserter S0..1Reference(BePractitioner | BePractitionerRole | BePatient | RelatedPerson)The person that asserted or informed about the addiction.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*ConditionDetailed information about conditions, problems or diagnoses
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-addiction-quantifier S0..1RatioExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-addiction-quantifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!SΣI0..1CodeableConceptThe clinical status of the addiction - whether it is active, resolved...
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!SΣI0..1CodeableConceptThe verification status of the addiction - whether it is suspected, confirmed, etc.
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.

... category S1..*CodeableConceptThe category of addiction, e.g. gaming, social, or substance addiction...
Binding: Addiction Category (extensible)
... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code SΣ1..1CodeableConceptThe specific addiction substance
Binding: Addiction Code (extensible)
... subject SΣ1..1Reference(BePatient)The person that has/had the addiction
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... onset[x] Σ0..1The time, event or period when the addiction started. If it's a period, this is the period in which the addiction appeared, not how long the addiction lasted.
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... abatement[x] I0..1The time, event or period when the addiction ended.
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate Σ0..1dateTimeThe date when the addiction was first recorded
... recorder SΣ0..1Reference(BePractitioner | BePractitionerRole | BePatient)The person that first recorded the addiction
... asserter SΣ0..1Reference(BePractitioner | BePractitionerRole | BePatient | RelatedPerson)The person that asserted or informed about the addiction.
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Condition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleBeVSAddictionCategory
Condition.severitypreferredCondition/DiagnosisSeverity
Condition.codeextensibleBeVSAddictionCode
Condition.stage.summaryexampleConditionStage
Condition.stage.typeexampleConditionStageType
Condition.evidence.codeexampleManifestationAndSymptomCodes

Constraints

IdPathDetailsRequirements
con-3ConditionCondition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
: clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4ConditionIf condition is abated, then clinicalStatus must be either inactive, resolved, or remission
: abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5ConditionCondition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2ConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ConditionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4ConditionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5ConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1Condition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.extension:AddictionQuantifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.extension:AddictionQuantifierMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.clinicalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.verificationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.abatement[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.recordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.asserterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-1Condition.stageStage SHALL have summary or assessment
: summary.exists() or assessment.exists()
ele-1Condition.stageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.stage.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.stage.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.stage.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.stage.summaryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.assessmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.stage.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-2Condition.evidenceevidence SHALL have code or details
: code.exists() or detail.exists()
ele-1Condition.evidenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.evidence.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.evidence.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.evidence.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Condition.evidence.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Condition.evidence.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.evidence.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Condition.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())