RIVO-Noord Zorgviewer Implementation Guide
1.27.0 - master
RIVO-Noord Zorgviewer Implementation Guide
1.27.0 - master
RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.27.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/AlcoholUse | Version: 1.27.0 | |||
| Active as of 2026-10-07 | Computable Name: AlcoholUse | |||
Alcoholgebruik
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Observation |
C | 0..* | Zib AlcoholUse | 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. | |
  code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example): Codes identifying names of simple observations. | |
  Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  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 | |
 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 | |
| effective[x] |
0..1 | Period | Clinically relevant time/time-period for observation Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"} | |
| issued |
0..1 | instant | Date/Time this was made available | |
| value[x] |
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 | Hoeveelheid alcohol | |
| 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 | 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"} | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📦3.0.2 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.value[x] | Base | extensible | AlcoholGebruikStatusCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Observation.component.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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 Zib AlcoholUse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Zib AlcoholUse | AlcoholUse | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) | |
| coding |
1..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| effective[x] |
0..1 | Period | Clinically relevant time/time-period for observation | |
| issued |
0..1 | instant | Date/Time this was made available | |
| value[x] |
1..1 | CodeableConcept | AlcoholUseStatus | |
| comment |
0..1 | string | Comment | |
| Slices for component |
Content/Rules for all slices | |||
| component:Amount |
0..1 | BackboneElement | Hoeveelheid alcohol | |
 code |
1..1 | CodeableConcept | Type of component observation (code / type) | |
 coding |
||||
| code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: 160573003 | |
| value[x] |
0..1 | Quantity | Amount | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Zib AlcoholUse | 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 | |||||
| effective[x] |
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 | Additional Content defined by implementations 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 Constraints: ext-1 | |||||
| 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 | |||||
| value[x] |
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 Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant Constraints: sqty-1 | ||||
| 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 | Hoeveelheid alcohol | |||||
| 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 | |||||
| value[x] |
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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📦3.0.2 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦3.0.2 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.value[x] | Base | extensible | AlcoholGebruikStatusCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Observation.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📦3.0.2 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📦3.0.2 | FHIR Std. |
| Observation.referenceRange.type | Base | extensible | Observation Reference Range Meaning Codes | 📦3.0.2 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📦3.0.2 | FHIR Std. |
| Observation.related.type | Base | required | ObservationRelationshipType | 📦3.0.2 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Observation.performer.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Zib AlcoholUse
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Zib AlcoholUse | 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. | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example): Codes identifying names of simple observations. | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | |
| 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 | |
| effective[x] |
0..1 | Period | Clinically relevant time/time-period for observation Example Example of an effectivePeriod: {"start":"1975","end":"2012-02-28"} | |
| issued |
0..1 | instant | Date/Time this was made available | |
| value[x] |
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 | Hoeveelheid alcohol | |
| 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 | 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"} | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📦3.0.2 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.value[x] | Base | extensible | AlcoholGebruikStatusCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Observation.component.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
Differential View
This structure is derived from Zib AlcoholUse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Zib AlcoholUse | AlcoholUse | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) | |
| coding |
1..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| effective[x] |
0..1 | Period | Clinically relevant time/time-period for observation | |
| issued |
0..1 | instant | Date/Time this was made available | |
| value[x] |
1..1 | CodeableConcept | AlcoholUseStatus | |
| comment |
0..1 | string | Comment | |
| Slices for component |
Content/Rules for all slices | |||
| component:Amount |
0..1 | BackboneElement | Hoeveelheid alcohol | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) | |
| coding |
||||
| code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: 160573003 | |
| value[x] |
0..1 | Quantity | Amount | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Zib AlcoholUse | 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 | |||||
| effective[x] |
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 | Additional Content defined by implementations 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 Constraints: ext-1 | |||||
| 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 | |||||
| value[x] |
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 Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant Constraints: sqty-1 | ||||
| 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 | Hoeveelheid alcohol | |||||
| 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 | |||||
| value[x] |
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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📦3.0.2 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📦3.0.2 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.value[x] | Base | extensible | AlcoholGebruikStatusCodelijst | 📦2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Observation.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📦3.0.2 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📦3.0.2 | FHIR Std. |
| Observation.referenceRange.type | Base | extensible | Observation Reference Range Meaning Codes | 📦3.0.2 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📦3.0.2 | FHIR Std. |
| Observation.related.type | Base | required | ObservationRelationshipType | 📦3.0.2 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.code | Base | example | LOINC Codes | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.dataAbsentReason | Base | extensible | Observation Value Absent Reason | 📦3.0.2 | FHIR Std. |
| Observation.component:Amount.interpretation | Base | extensible | Observation Interpretation Codes | 📦3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Observation.performer.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Zib AlcoholUse
Other representations of profile: CSV, Excel, Schematron