NAPKON Vaccination Module
1.0.0 - trial-use

NAPKON Vaccination Module - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: Regular Alcohol Intake

Defining URL:https://www.napkon.de/fhir/StructureDefinition/regular-alcohol-intake
Version:1.0.0
Name:RegularAlcoholIntake
Title:Regular Alcohol Intake
Status:Active as of 2021-10-05
Definition:

Whether a patient regularly drinks alcohol

Publisher:Charité - Universitätsmedizin Berlin
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.napkon.de/fhir/StructureDefinition/regular-alcohol-intake

Guidance

Parameter Case Report Form Response Options
Do you drink alcohol occasionally? Days per week alcoholic drinks consumed”
Response Option Observation.valueQuantity Observation.valueRange.low Observation.valueRange.high Observation.dataAbsentReason
Yes, once a month or less often - - 0.25 #/wk -
Yes, 2-4 times a month - 0.25 #/wk 0.5 #/wk -
Yes, 2-3 times a week - 2 #/wk 3 #/wk -
Yes, 4 times a week or more - 4 #/wk - -
No 0 - - -
No more (I used to drink alcohol occasionally.) 0 - - -
No answer - - - set (from ValueSet)

This profile is used in conjunction with the Regular Alcohol Intake Quantity profile to indicate the number of alcoholic beverages per day.

This profile of a FHIR Observation is derived from the Observation FHIR resource.

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
value-or-data-absent-reason: If there is no value in an Observation, a data absent reason must be present or vice versa
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 81032-5
...... display1..1stringRepresentation defined by the system
Fixed Value: Days per week alcoholic drinks consumed
...... userSelected0..1booleanIf this coding was chosen directly by the user
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(Patient)A reference from one resource to another
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... Slices for value[x] SΣI0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueRangeRange
.... value[x]:valueQuantity SΣI0..1QuantityActual result
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ1..1stringUnit representation
Required Pattern: PerWeek
..... system SΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
Required Pattern: /wk
.... value[x]:valueRange SΣI0..1RangeActual result
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... low Σ0..1SimpleQuantityLow limit
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... unit SΣ1..1stringUnit representation
Required Pattern: PerWeek
...... system SΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Required Pattern: /wk
..... high Σ0..1SimpleQuantityHigh limit
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... unit SΣ1..1stringUnit representation
Required Pattern: PerWeek
...... system SΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code SΣ1..1codeCoded form of the unit
Required Pattern: /wk
.... value[x]:valueCodeableConcept SΣI0..1CodeableConceptActual result
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: https://www.napkon.de/fhir/CodeSystem/napkon-vaccination-module
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: no-longer
...... display1..1stringRepresentation defined by the system
Fixed Value: No longer
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementComponent results
.... 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 Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
value-or-data-absent-reason: If there is no value in an Observation, a data absent reason must be present or vice versa
... subject Σ1..1Reference(Patient)A reference from one resource to another
... Slices for value[x] ΣI0..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueRangeRange
.... value[x]:valueQuantity ΣI0..1QuantityActual result
..... value Σ1..1decimalNumerical value (with implicit precision)
..... unit Σ1..1stringUnit representation
Required Pattern: PerWeek
..... system ΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code Σ1..1codeCoded form of the unit
Required Pattern: /wk
.... value[x]:valueRange ΣI0..1RangeActual result
..... low Σ0..1SimpleQuantityLow limit
...... value Σ1..1decimalNumerical value (with implicit precision)
...... unit Σ1..1stringUnit representation
Required Pattern: PerWeek
...... system ΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ1..1codeCoded form of the unit
Required Pattern: /wk
..... high Σ0..1SimpleQuantityHigh limit
...... value Σ1..1decimalNumerical value (with implicit precision)
...... unit Σ1..1stringUnit representation
Required Pattern: PerWeek
...... system ΣI1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ1..1codeCoded form of the unit
Required Pattern: /wk
.... value[x]:valueCodeableConcept ΣI0..1CodeableConceptActual result
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: https://www.napkon.de/fhir/CodeSystem/napkon-vaccination-module
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: no-longer
...... display1..1stringRepresentation defined by the system
Fixed Value: No longer

doco Documentation for this format

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
value-or-data-absent-reason: If there is no value in an Observation, a data absent reason must be present or vice versa
... code
.... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc 1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 81032-5
...... display1..1stringRepresentation defined by the system
Fixed Value: Days per week alcoholic drinks consumed
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
... subject S1..1Reference(Patient)A reference from one resource to another
... Slices for value[x] S0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueRangeRange
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S1..1stringUnit representation
Required Pattern: PerWeek
.... system S1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Required Pattern: /wk
... valueRange S0..1RangeActual result
.... low
..... value S1..1decimalNumerical value (with implicit precision)
..... unit S1..1stringUnit representation
Required Pattern: PerWeek
..... system S1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Required Pattern: /wk
.... high
..... value S1..1decimalNumerical value (with implicit precision)
..... unit S1..1stringUnit representation
Required Pattern: PerWeek
..... system S1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Required Pattern: /wk
... valueCodeableConcept S0..1CodeableConceptActual result
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://www.napkon.de/fhir/CodeSystem/napkon-vaccination-module
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: no-longer
..... display1..1stringRepresentation defined by the system
Fixed Value: No longer

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 5 elements (12 nested mandatory elements)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of pattern:$this
  • The element Observation.value[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
value-or-data-absent-reasonObservationIf there is no value in an Observation, a data absent reason must be present or vice versa
: value.exists() or dataAbsentReason.exists()
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()