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 - Detailed Descriptions

Definitions for the be-model-addiction Profile.

1. BeAddiction
Definition

This is the base resource type for everything.

Control0..*
2. BeAddiction.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typestring
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. BeAddiction.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. BeAddiction.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. BeAddiction.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. BeAddiction.identifier
Definition

The business identifier(s) for the addiction condition - This is an optional attribute, used for example to track an addiction throughout its lifecycle, or across vaults.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
7. BeAddiction.clinicalStatus
Control0..1
Typecode(code)
8. BeAddiction.verificationStatus
Control0..1
Typecode(code)
9. BeAddiction.subject
Definition

The patient

Control1..1
TypeReference(BePatient)
10. BeAddiction.type
Definition

Here the type of addiction will be specified (e.g. alcohol, drugs, medication). It SHOULD be expressed in a codified way (Valueset will be delivered by NIHDI).

Control1..1
TypeCodeableConcept(CodeableConcept)
11. BeAddiction.code
Definition

Here it is possible to further refine the addiction information e.g. when "narcotics" is indicated, this can specify the substance

Control0..1
TypeCodeableConcept(CodeableConcept)
12. BeAddiction.recordedDate
Definition

The date when the addiction is being recorded or updated

Control1..1
TypedateTime(dateTime)
13. BeAddiction.period
Definition

The actual period this addiction was true. (e.g. used when a patient used to abuse alcohol) - or the beginning of addiction in case the addiction is still active

Control0..1
TypeBackboneElement
14. BeAddiction.period.time
Definition

The actual period of the addiction or the beginning of addiction in case the addiction is still active

Control0..1
TypePeriod(Period)
15. BeAddiction.period.text
Definition

A free text indication of the time period of addiction - e.g. as "teenager", "approx 5 years ago", etc

Control0..1
TypeCodeableConcept
16. BeAddiction.quantity
Definition

e.g. number of cigarettes per day

Control0..1
TypeQuantity(Quantity)
17. BeAddiction.inTreatment
Definition

Is this patient following a treatment for this addiction?

Control0..1
TypeBoolean
18. BeAddiction.treatment
Definition

Is this patient following a treatment for this addiction? (In technical reality, this will be actually a Procedure instance that refers to the Addiction instance)

Control0..*
TypeReference
19. BeAddiction.recorder
Definition

Clinical parties or informers that participate in reporting the addiction

Control1..*
TypeBackboneElement
20. BeAddiction.recorder.performer
Definition

Who was responsible for asserting the observed value as "true".

Control1..1
TypeCodeableReference
21. BeAddiction.recorder.performer.reference
Definition

Who was responsible for asserting the observed value as "true". (Reference)

Control1..1
TypeReference(BePractitioner)
22. BeAddiction.recorder.performerCode
Definition

To mark the performer as 'INF' (informer) - in case the addiction is reported by family

Control0..1
BindingThe codes SHALL be taken from http://hl7.org/fhir/valueset-performer-function.html
TypeCodeableConcept(CodeableConcept)
23. BeAddiction.note
Definition

Additional information about the addiction - this can be relevant history, any remarks by the patient or professional, etc.

Control0..*
TypeAnnotation(Annotation)