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 IllnessPerception
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-IllnessPerception | Version: 1.3.15 | |||
| Active as of 2025-09-22 | Computable Name: Zib IllnessPerception | |||
Copyright/Legal: CC0 |
||||
In nearly all cases, a lengthy or life-threatening illness is a traumatic experience for the patient and their environment. Every patient deals with this in their own way. The way in which a person deals with problems and stress is also referred to as coping. Illness perception entails both the way the patient sees their situation and the way in which the patient and their environment deal with the situation (coping strategies).
Information on the extent of the insight of the patient and their environment into the consequences of their disease enables nurses to properly support the patient and their family in learning to deal with the illness or health problem.
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
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Observation |
0..* | nl-core-observation | IllnessPerception | |
  code |
||||
   Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
   coding:illnessPerceptionCode |
1..1 | Coding | Code defined by a terminology system | |
 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: 363910003 | |
 display |
0..1 | string | Representation defined by the system | |
  subject |
1..1 | Reference(nl-core-patient) | Who and/or what this is about | |
| Slices for component |
0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | |
 component:PatientIllnessInsight |
0..* | BackboneElement | Patient Illness Insight | |
  code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 27026000 | |
 Slices for valueString |
Content/Rules for all slices | |||
 valueString:valueString |
0..1 | string | Actual component result | |
| component:CopingWithIllnessByPatient |
0..* | BackboneElement | Coping With Illness By Patient | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 364667003 | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Actual component result | |
| component:CopingWithIllnessByFamily |
0..* | BackboneElement | Coping With Illness By Family | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 405199009 | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Actual component result | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | nl-core-observation | IllnessPerception 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 |
| coding:illnessPerceptionCode |
Σ | 1..1 | Coding | Code defined by a terminology system |
| 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: 363910003 |
| display |
Σ | 0..1 | string | Representation defined by the system |
| subject |
Σ | 1..1 | Reference(nl-core-patient) | Who and/or what this is about |
| Slices for component |
Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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:PatientIllnessInsight |
Σ | 0..* | BackboneElement | Patient Illness Insight |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 27026000 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| component:CopingWithIllnessByPatient |
Σ | 0..* | BackboneElement | Coping With Illness By Patient |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 364667003 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| component:CopingWithIllnessByFamily |
Σ | 0..* | BackboneElement | Coping With Illness By Family |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 405199009 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|3.0.2From the FHIR Standard | |
| Observation.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:PatientIllnessInsight.code | example | Pattern Value: SNOMED-CT Code 27026000http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:CopingWithIllnessByPatient.code | example | Pattern Value: SNOMED-CT Code 364667003http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:CopingWithIllnessByFamily.code | example | Pattern Value: SNOMED-CT Code 405199009http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | nl-core-observation | IllnessPerception 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 | ||||
| coding:illnessPerceptionCode |
Σ | 1..1 | 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 |
Σ | 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: 363910003 | ||||
| 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(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 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| 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 | ||||
| value[x] |
ΣC | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueAttachment |
Attachment | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| 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 | Comments about result | |||||
| 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 pattern: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:PatientIllnessInsight |
Σ | 0..* | BackboneElement | Patient Illness Insight | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 27026000 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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:CopingWithIllnessByPatient |
Σ | 0..* | BackboneElement | Coping With Illness By Patient | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 364667003 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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:CopingWithIllnessByFamily |
Σ | 0..* | BackboneElement | Coping With Illness By Family | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 405199009 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|3.0.2From the FHIR Standard | ||||
| Observation.category | preferred | Observation Category Codeshttp://hl7.org/fhir/ValueSet/observation-category|3.0.2From the FHIR Standard | ||||
| Observation.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.bodySite | example | SNOMED CT Body Structureshttp://hl7.org/fhir/ValueSet/body-site|3.0.2From the FHIR Standard | ||||
| Observation.method | example | Observation Methodshttp://hl7.org/fhir/ValueSet/observation-methods|3.0.2From the FHIR Standard | ||||
| Observation.referenceRange.type | extensible | Observation Reference Range Meaning Codeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|3.0.2From the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | Observation Reference Range Applies To Codeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|3.0.2From the FHIR Standard | ||||
| Observation.related.type | required | ObservationRelationshipTypehttp://hl7.org/fhir/ValueSet/observation-relationshiptypes|3.0.2From the FHIR Standard | ||||
| Observation.component.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.code | example | Pattern Value: SNOMED-CT Code 27026000http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.code | example | Pattern Value: SNOMED-CT Code 364667003http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.code | example | Pattern Value: SNOMED-CT Code 405199009http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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-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() |
This structure is derived from nl-core-observation
Summary
Mandatory: 4 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | nl-core-observation | IllnessPerception | |
| code |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
| coding:illnessPerceptionCode |
1..1 | Coding | Code defined by a terminology system | |
| 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: 363910003 | |
| display |
0..1 | string | Representation defined by the system | |
| subject |
1..1 | Reference(nl-core-patient) | Who and/or what this is about | |
| Slices for component |
0..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | |
| component:PatientIllnessInsight |
0..* | BackboneElement | Patient Illness Insight | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 27026000 | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Actual component result | |
| component:CopingWithIllnessByPatient |
0..* | BackboneElement | Coping With Illness By Patient | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 364667003 | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Actual component result | |
| component:CopingWithIllnessByFamily |
0..* | BackboneElement | Coping With Illness By Family | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| 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: 405199009 | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Actual component result | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | nl-core-observation | IllnessPerception 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 |
| coding:illnessPerceptionCode |
Σ | 1..1 | Coding | Code defined by a terminology system |
| 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: 363910003 |
| display |
Σ | 0..1 | string | Representation defined by the system |
| subject |
Σ | 1..1 | Reference(nl-core-patient) | Who and/or what this is about |
| Slices for component |
Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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:PatientIllnessInsight |
Σ | 0..* | BackboneElement | Patient Illness Insight |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 27026000 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| component:CopingWithIllnessByPatient |
Σ | 0..* | BackboneElement | Coping With Illness By Patient |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 364667003 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| component:CopingWithIllnessByFamily |
Σ | 0..* | BackboneElement | Coping With Illness By Family |
| 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. Required Pattern: At least the following |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional Content defined by implementations | |
| 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: 405199009 | |
| 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]:valueString |
Σ | 0..1 | string | Actual component result |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|3.0.2From the FHIR Standard | |
| Observation.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:PatientIllnessInsight.code | example | Pattern Value: SNOMED-CT Code 27026000http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:CopingWithIllnessByPatient.code | example | Pattern Value: SNOMED-CT Code 364667003http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | |
| Observation.component:CopingWithIllnessByFamily.code | example | Pattern Value: SNOMED-CT Code 405199009http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | nl-core-observation | IllnessPerception 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 | ||||
| coding:illnessPerceptionCode |
Σ | 1..1 | 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 |
Σ | 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: 363910003 | ||||
| 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(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 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| 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 | ||||
| value[x] |
ΣC | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueAttachment |
Attachment | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| 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 | Comments about result | |||||
| 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 pattern: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:PatientIllnessInsight |
Σ | 0..* | BackboneElement | Patient Illness Insight | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 27026000 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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:CopingWithIllnessByPatient |
Σ | 0..* | BackboneElement | Coping With Illness By Patient | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 364667003 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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:CopingWithIllnessByFamily |
Σ | 0..* | BackboneElement | Coping With Illness By Family | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| 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: 405199009 | |||||
| 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]:valueString |
Σ | 0..1 | string | Actual component result | ||||
| 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|3.0.2From the FHIR Standard | ||||
| Observation.category | preferred | Observation Category Codeshttp://hl7.org/fhir/ValueSet/observation-category|3.0.2From the FHIR Standard | ||||
| Observation.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.bodySite | example | SNOMED CT Body Structureshttp://hl7.org/fhir/ValueSet/body-site|3.0.2From the FHIR Standard | ||||
| Observation.method | example | Observation Methodshttp://hl7.org/fhir/ValueSet/observation-methods|3.0.2From the FHIR Standard | ||||
| Observation.referenceRange.type | extensible | Observation Reference Range Meaning Codeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|3.0.2From the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | Observation Reference Range Applies To Codeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|3.0.2From the FHIR Standard | ||||
| Observation.related.type | required | ObservationRelationshipTypehttp://hl7.org/fhir/ValueSet/observation-relationshiptypes|3.0.2From the FHIR Standard | ||||
| Observation.component.code | example | LOINC Codes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.code | example | Pattern Value: SNOMED-CT Code 27026000http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:PatientIllnessInsight.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.code | example | Pattern Value: SNOMED-CT Code 364667003http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByPatient.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.code | example | Pattern Value: SNOMED-CT Code 405199009http://hl7.org/fhir/ValueSet/observation-codes|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.dataAbsentReason | extensible | Observation Value Absent Reasonhttp://hl7.org/fhir/ValueSet/observation-valueabsentreason|3.0.2From the FHIR Standard | ||||
| Observation.component:CopingWithIllnessByFamily.interpretation | extensible | Observation Interpretation Codeshttp://hl7.org/fhir/ValueSet/observation-interpretation|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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-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() |
This structure is derived from nl-core-observation
Summary
Mandatory: 4 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
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