HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BEAddiction

This is the logical model of an addiction of a patient. Initially based on the input of the NIHDI. This model represents a known, suspected or resolved addiction. This models does not intend to represent a point-in-time observation of substance intake or related event or behaviour. In other words, this logical model represents the addiction condition, not an addiction-related event or observation.

The official URL for this profile is: 

https://www.hl7belgium.org/fhir/StructureDefinition/be-model-addiction

Formal Views of Profile Content

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

This structure is derived from Resource

Summary

Mandatory: 0 element (6 nested mandatory elements)

Structures

This structure refers to these other structures:

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BeAddiction 0..*ResourceA subject's addiction
... identifier 0..1IdentifierThe business identifier(s) for the addiction condition
... clinicalStatus 0..1codeThe clinical status of the addiction - whether it is active, resolved...
... verificationStatus 0..1codeThe verification status of the addiction - whether it is suspected, confirmed, etc.
... type 1..1CodeableConceptThe type of addiction
... code 0..1CodeableConceptThe specific addiction substance or activity
... recordedDate 1..1dateTimeThe date when the addiction is being recorded or updated
... period 0..1BackboneElementThe time when the patient suffered or suffers from addiction
.... time 0..1PeriodThe actual time period of the addiction, if it is known
.... text 0..1CodeableConceptA free text indication of the time period of addiction - e.g. "teenager", etc.
... quantity 0..1QuantityQuantifier of addiction e.g. number of cigarettes per day
... inTreatment 0..1BooleanWhether the addiction is known to be under treatment
... treatment 0..*Reference()The links to the treatment(s) associated with this addition, if existing and known
... recorder 1..*BackboneElementParticipants that report the addiction
.... performer 1..1CodeableReference()Person that performed the recording or reporting
..... reference 1..1Reference(BePractitioner)Reference to person that performed the recording or reporting
.... performerCode 0..1CodeableConceptThe role or action that the person took - for example informer, recorder, verifier..
Binding: http://hl7.org/fhir/valueset-performer-function.html (required)
... note 0..*AnnotationAdditional information about the addiction

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BeAddiction 0..*ResourceA subject's addiction
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... clinicalStatus 0..1codeThe clinical status of the addiction - whether it is active, resolved...
... verificationStatus 0..1codeThe verification status of the addiction - whether it is suspected, confirmed, etc.
... subject 1..1Reference(BePatient)The person that has/had the addiction
... type 1..1CodeableConceptThe type of addiction
... code 0..1CodeableConceptThe specific addiction substance or activity
... recordedDate 1..1dateTimeThe date when the addiction is being recorded or updated
... period 0..1BackboneElementThe time when the patient suffered or suffers from addiction
.... time 0..1PeriodThe actual time period of the addiction, if it is known
.... text 0..1CodeableConceptA free text indication of the time period of addiction - e.g. "teenager", etc.
... quantity 0..1QuantityQuantifier of addiction e.g. number of cigarettes per day
... inTreatment 0..1BooleanWhether the addiction is known to be under treatment
... treatment 0..*Reference()The links to the treatment(s) associated with this addition, if existing and known
... recorder 1..*BackboneElementParticipants that report the addiction
.... performer 1..1CodeableReference()Person that performed the recording or reporting
..... reference 1..1Reference(BePractitioner)Reference to person that performed the recording or reporting
.... performerCode 0..1CodeableConceptThe role or action that the person took - for example informer, recorder, verifier..
Binding: http://hl7.org/fhir/valueset-performer-function.html (required)
... note 0..*AnnotationAdditional information about the addiction

doco Documentation for this format

This structure is derived from Resource

Summary

Mandatory: 0 element (6 nested mandatory elements)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BeAddiction 0..*ResourceA subject's addiction
... identifier 0..1IdentifierThe business identifier(s) for the addiction condition
... clinicalStatus 0..1codeThe clinical status of the addiction - whether it is active, resolved...
... verificationStatus 0..1codeThe verification status of the addiction - whether it is suspected, confirmed, etc.
... type 1..1CodeableConceptThe type of addiction
... code 0..1CodeableConceptThe specific addiction substance or activity
... recordedDate 1..1dateTimeThe date when the addiction is being recorded or updated
... period 0..1BackboneElementThe time when the patient suffered or suffers from addiction
.... time 0..1PeriodThe actual time period of the addiction, if it is known
.... text 0..1CodeableConceptA free text indication of the time period of addiction - e.g. "teenager", etc.
... quantity 0..1QuantityQuantifier of addiction e.g. number of cigarettes per day
... inTreatment 0..1BooleanWhether the addiction is known to be under treatment
... treatment 0..*Reference()The links to the treatment(s) associated with this addition, if existing and known
... recorder 1..*BackboneElementParticipants that report the addiction
.... performer 1..1CodeableReference()Person that performed the recording or reporting
..... reference 1..1Reference(BePractitioner)Reference to person that performed the recording or reporting
.... performerCode 0..1CodeableConceptThe role or action that the person took - for example informer, recorder, verifier..
Binding: http://hl7.org/fhir/valueset-performer-function.html (required)
... note 0..*AnnotationAdditional information about the addiction

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BeAddiction 0..*ResourceA subject's addiction
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... clinicalStatus 0..1codeThe clinical status of the addiction - whether it is active, resolved...
... verificationStatus 0..1codeThe verification status of the addiction - whether it is suspected, confirmed, etc.
... subject 1..1Reference(BePatient)The person that has/had the addiction
... type 1..1CodeableConceptThe type of addiction
... code 0..1CodeableConceptThe specific addiction substance or activity
... recordedDate 1..1dateTimeThe date when the addiction is being recorded or updated
... period 0..1BackboneElementThe time when the patient suffered or suffers from addiction
.... time 0..1PeriodThe actual time period of the addiction, if it is known
.... text 0..1CodeableConceptA free text indication of the time period of addiction - e.g. "teenager", etc.
... quantity 0..1QuantityQuantifier of addiction e.g. number of cigarettes per day
... inTreatment 0..1BooleanWhether the addiction is known to be under treatment
... treatment 0..*Reference()The links to the treatment(s) associated with this addition, if existing and known
... recorder 1..*BackboneElementParticipants that report the addiction
.... performer 1..1CodeableReference()Person that performed the recording or reporting
..... reference 1..1Reference(BePractitioner)Reference to person that performed the recording or reporting
.... performerCode 0..1CodeableConceptThe role or action that the person took - for example informer, recorder, verifier..
Binding: http://hl7.org/fhir/valueset-performer-function.html (required)
... note 0..*AnnotationAdditional information about the addiction

doco Documentation for this format

 

​Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
BeAddiction.languagepreferredCommonLanguages
Max Binding: AllLanguages
BeAddiction.recorder.performerCoderequiredhttp://hl7.org/fhir/valueset-performer-function.html

Constraints

Constraints

IdPathDetailsRequirements