Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCIM AlcoholUse

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse Version: 1.3.15
Active as of 2025-09-22 Computable Name: Zib AlcoholUse

Copyright/Legal: CC0

AlcoholUse as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) version v3.1, release 2017.

In the context of this information model, alcohol is the collective term for alcoholic beverages consumed as a leisure product. This information model describes the information asked of the patient about their alcohol use.

During the social anamnesis, the patient is frequently asked about their alcohol consumption. Excessive (episodic) alcohol consumption may influence the current treatment and diagnostics. Alcohol-related problems are diagnosed as secondary diagnoses more and more often. Source: Guidelines - Multidisciplinary guidelines for Disorders in alcohol use (CBO, 2009)

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

This structure is derived from nl-core-observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* nl-core-observation AlcoholUse
... code
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode 1..1 Coding AlcoholUseCode
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display 0..1 string Representation defined by the system
... Slices for effectivePeriod Content/Rules for all slices
.... effectivePeriod:effectivePeriod 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
..... start 0..1 dateTime Startdate
..... end 0..1 dateTime StopDate
... Slices for valueCodeableConcept Content/Rules for all slices
.... valueCodeableConcept:valueCodeableConcept 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:Amount 0..1 BackboneElement Component results
..... code
...... coding
....... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 160573003
....... display 0..1 string Representation defined by the system
..... Slices for valueQuantity Content/Rules for all slices
...... valueQuantity:valueQuantity 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.valueCodeableConcept:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* nl-core-observation AlcoholUse
Constraints: obs-7, obs-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode Σ 1..1 Coding AlcoholUseCode
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display Σ 0..1 string Representation defined by the system
... subject Σ 1..1 Reference(Group | Device | nl-core-location | nl-core-patient) Who and/or what this is about
... Slices for effective[x] Σ 0..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectivePeriod Σ 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept ΣC 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... comment 0..1 string Comment
Example Example of Comment: consumptie alcohol alleen in het weekend
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
.... component:Amount Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
..... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Closed by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueQuantity Σ 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|3.0.2
From the FHIR Standard
Observation.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.value[x]:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG
Observation.component.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component:Amount.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* nl-core-observation AlcoholUse
Constraints: obs-7, obs-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) Fulfills plan, proposal or order
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode Σ 1..1 Coding AlcoholUseCode
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | Device | nl-core-location | nl-core-patient) Who and/or what this is about
... context 0..1 Reference(nl-core-episodeofcare | HCIM Encounter | gp-Encounter) Healthcare event during which this observation is made
... Slices for effective[x] Σ 0..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectivePeriod Σ 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Startdate
..... end ΣC 0..1 dateTime StopDate
... issued Σ 0..1 instant Date/Time this was made available
... performer Σ 0..* Reference(nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Who is responsible for the observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept ΣC 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
... comment 0..1 string Comment
Example Example of Comment: consumptie alcohol alleen in het weekend
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... related Σ 0..* BackboneElement Resource related to this observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type 0..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.
.... target 1..1 Reference(Observation | QuestionnaireResponse | Sequence) Resource that is related to this one
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:Amount Σ 0..1 BackboneElement Component results
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 160573003
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Closed by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueQuantity Σ 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|3.0.2
From the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category|3.0.2
From the FHIR Standard
Observation.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.value[x]:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard
Observation.bodySiteexampleSNOMED CT Body Structures
http://hl7.org/fhir/ValueSet/body-site|3.0.2
From the FHIR Standard
Observation.methodexampleObservation Methods
http://hl7.org/fhir/ValueSet/observation-methods|3.0.2
From the FHIR Standard
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
http://hl7.org/fhir/ValueSet/referencerange-meaning|3.0.2
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
http://hl7.org/fhir/ValueSet/referencerange-appliesto|3.0.2
From the FHIR Standard
Observation.related.typerequiredObservationRelationshipType
http://hl7.org/fhir/ValueSet/observation-relationshiptypes|3.0.2
From the FHIR Standard
Observation.component.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.component.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard
Observation.component:Amount.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component:Amount.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.component:Amount.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()

This structure is derived from nl-core-observation

Summary

Mandatory: 5 elements
Fixed: 4 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.component

Differential View

This structure is derived from nl-core-observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* nl-core-observation AlcoholUse
... code
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode 1..1 Coding AlcoholUseCode
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display 0..1 string Representation defined by the system
... Slices for effectivePeriod Content/Rules for all slices
.... effectivePeriod:effectivePeriod 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
..... start 0..1 dateTime Startdate
..... end 0..1 dateTime StopDate
... Slices for valueCodeableConcept Content/Rules for all slices
.... valueCodeableConcept:valueCodeableConcept 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:Amount 0..1 BackboneElement Component results
..... code
...... coding
....... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 160573003
....... display 0..1 string Representation defined by the system
..... Slices for valueQuantity Content/Rules for all slices
...... valueQuantity:valueQuantity 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.valueCodeableConcept:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* nl-core-observation AlcoholUse
Constraints: obs-7, obs-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode Σ 1..1 Coding AlcoholUseCode
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display Σ 0..1 string Representation defined by the system
... subject Σ 1..1 Reference(Group | Device | nl-core-location | nl-core-patient) Who and/or what this is about
... Slices for effective[x] Σ 0..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectivePeriod Σ 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept ΣC 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... comment 0..1 string Comment
Example Example of Comment: consumptie alcohol alleen in het weekend
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
.... component:Amount Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
..... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Closed by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueQuantity Σ 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|3.0.2
From the FHIR Standard
Observation.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.value[x]:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG
Observation.component.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component:Amount.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* nl-core-observation AlcoholUse
Constraints: obs-7, obs-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) Fulfills plan, proposal or order
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:alcoholUseCode Σ 1..1 Coding AlcoholUseCode
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 228273003
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | Device | nl-core-location | nl-core-patient) Who and/or what this is about
... context 0..1 Reference(nl-core-episodeofcare | HCIM Encounter | gp-Encounter) Healthcare event during which this observation is made
... Slices for effective[x] Σ 0..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectivePeriod Σ 0..1 Period Clinically relevant time/time-period for observation
Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"}
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Startdate
..... end ΣC 0..1 dateTime StopDate
... issued Σ 0..1 instant Date/Time this was made available
... performer Σ 0..* Reference(nl-core-organization | nl-core-patient | nl-core-practitioner | nl-core-relatedperson) Who is responsible for the observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueCodeableConcept ΣC 1..1 CodeableConcept AlcoholUseStatus
Binding: AlcoholGebruikStatusCodelijst (extensible): Codes defining the alcohol intake status.
Example Example of AlcoholUseStatus: {"coding":[{"system":"http://snomed.info/sct","code":"219006","display":"Current drinker of alcohol"}]}
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
... comment 0..1 string Comment
Example Example of Comment: consumptie alcohol alleen in het weekend
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... related Σ 0..* BackboneElement Resource related to this observation
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type 0..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required): Codes specifying how two observations are related.
.... target 1..1 Reference(Observation | QuestionnaireResponse | Sequence) Resource that is related to this one
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code.coding.code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:Amount Σ 0..1 BackboneElement Component results
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 160573003
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Closed by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueAttachment Attachment
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... value[x]:valueQuantity Σ 0..1 Quantity Amount
Example Example of Amount: {"value":32,"unit":"glasses/week","system":"http://unitsofmeasure.org","code":"{glasses}/wk"}
Example Example of Amount: {"value":1,"unit":"alcoholic_units/day","system":"http://unitsofmeasure.org","code":"{alcoholic_units}/d"}
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: Observation Value Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..1 CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languageextensibleCommon Languages
http://hl7.org/fhir/ValueSet/languages|3.0.2
From the FHIR Standard
Additional Bindings Purpose
All Languages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|3.0.2
From the FHIR Standard
Observation.categorypreferredObservation Category Codes
http://hl7.org/fhir/ValueSet/observation-category|3.0.2
From the FHIR Standard
Observation.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.value[x]:valueCodeableConceptextensibleAlcoholGebruikStatusCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.3.2--20171231000000
From this IG
Observation.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard
Observation.bodySiteexampleSNOMED CT Body Structures
http://hl7.org/fhir/ValueSet/body-site|3.0.2
From the FHIR Standard
Observation.methodexampleObservation Methods
http://hl7.org/fhir/ValueSet/observation-methods|3.0.2
From the FHIR Standard
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
http://hl7.org/fhir/ValueSet/referencerange-meaning|3.0.2
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
http://hl7.org/fhir/ValueSet/referencerange-appliesto|3.0.2
From the FHIR Standard
Observation.related.typerequiredObservationRelationshipType
http://hl7.org/fhir/ValueSet/observation-relationshiptypes|3.0.2
From the FHIR Standard
Observation.component.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.component.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard
Observation.component:Amount.codeexampleLOINC Codes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes|3.0.2
From the FHIR Standard
Observation.component:Amount.dataAbsentReasonextensibleObservation Value Absent Reason
http://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2
From the FHIR Standard
Observation.component:Amount.interpretationextensibleObservation Interpretation Codes
http://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorObservationIf 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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()

This structure is derived from nl-core-observation

Summary

Mandatory: 5 elements
Fixed: 4 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.component

 

Other representations of profile: CSV, Excel, Schematron