DIPS Core Implementation Guide
0.1.0 - ci-build
Norway
DIPS Core Implementation Guide
0.1.0 - ci-build
Norway
DIPS Core Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://dips.no/fhir/StructureDefinition/DIPSBasisLabObservationR4 | Version: 0.1.0 | |||
| Draft as of 2026-11-10 | Computable Name: DIPSBasisLabObservationR4 | |||
The DIPS Basis Lab Observation Profile inherits from the FHIR Observation resource; refer to it for scope and usage definitions
Example Usage Scenarios:
The following are example usage scenarios for this profile:
Query by patient identifier, subject, category, or status
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..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError Binding: ObservationStatus (required): Codes providing the status of an observation. | |
 code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
  Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
  coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |
  system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |
 coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |
 subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
 valueQuantity |
Quantity | |||
| valueString |
string | |||
| value[x]:valueQuantity |
C | 0..1 | Quantity | Actual result |
 Slices for extension |
Content/Rules for all slices | |||
 extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| value[x]:valueString |
C | 0..1 | string | Actual result |
 note |
0..1 | Annotation | Comments about the observation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.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 Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Observation | Measurements and simple assertions | |
 contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |
| identifier |
||||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.3.6.1.4.1.9038.62 (no extensions allowed) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| basedOn |
0..0 | Fulfills plan, proposal or order | ||
| partOf |
0..0 | Part of referenced event | ||
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError | |
| category |
0..0 | Classification of type of observation | ||
| code |
||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |
 id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| focus |
0..0 | What the observation is about, when it is not about the subject of record | ||
| encounter |
0..0 | Healthcare event during which this observation is made | ||
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |
| issued |
0..0 | Date/Time this version was made available | ||
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |
| Slices for value[x] |
0..1 | Actual result Slice: Unordered, Open by type:$this | ||
| valueQuantity |
Quantity | |||
| valueString |
string | |||
| value[x]:valueQuantity |
0..1 | Quantity | Actual result | |
| id |
0..0 | Unique id for inter-element referencing | ||
| Slices for extension |
Content/Rules for all slices | |||
| extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| value[x]:valueString |
0..1 | string | Actual result | |
| dataAbsentReason |
0..0 | Why the result is missing | ||
| interpretation |
||||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/ValueSet/observation-interpretation (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| note |
0..1 | Annotation | Comments about the observation | |
| bodySite |
0..0 | Observed body part | ||
| method |
0..0 | How it was done | ||
| specimen |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| display |
0..0 | Text alternative for the resource | ||
| device |
0..0 | (Measurement) Device | ||
| referenceRange |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| low |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| unit |
0..0 | Unit representation | ||
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| high |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| unit |
0..0 | Unit representation | ||
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| type |
0..0 | Reference range qualifier | ||
| appliesTo |
0..0 | Reference range population | ||
| age |
0..0 | Applicable age range, if relevant | ||
| hasMember |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| derivedFrom |
0..0 | Related measurements the observation is made from | ||
| component |
0..0 | Component results | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||
| 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: CommonLanguages (preferred): 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.3.6.1.4.1.9038.62 (no extensions allowed) | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||
| coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |||||
| 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: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |||||
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
| valueQuantity |
Quantity | |||||||
| valueString |
string | |||||||
| value[x]:valueQuantity |
C | 0..1 | Quantity | Actual result | ||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation | |||||
| value[x]:valueString |
C | 0..1 | string | Actual result | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| 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://hl7.org/fhir/ValueSet/observation-interpretation (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| note |
0..1 | Annotation | Comments about the observation | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).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 Observation
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 4 elements
Prohibited: 56 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |
| coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |
| subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
| valueQuantity |
Quantity | |||
| valueString |
string | |||
| value[x]:valueQuantity |
C | 0..1 | Quantity | Actual result |
| Slices for extension |
Content/Rules for all slices | |||
| extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| value[x]:valueString |
C | 0..1 | string | Actual result |
| note |
0..1 | Annotation | Comments about the observation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.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 Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
|
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Observation | Measurements and simple assertions | |
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |
| identifier |
||||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.3.6.1.4.1.9038.62 (no extensions allowed) | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| basedOn |
0..0 | Fulfills plan, proposal or order | ||
| partOf |
0..0 | Part of referenced event | ||
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError | |
| category |
0..0 | Classification of type of observation | ||
| code |
||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| focus |
0..0 | What the observation is about, when it is not about the subject of record | ||
| encounter |
0..0 | Healthcare event during which this observation is made | ||
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |
| issued |
0..0 | Date/Time this version was made available | ||
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |
| Slices for value[x] |
0..1 | Actual result Slice: Unordered, Open by type:$this | ||
| valueQuantity |
Quantity | |||
| valueString |
string | |||
| value[x]:valueQuantity |
0..1 | Quantity | Actual result | |
| id |
0..0 | Unique id for inter-element referencing | ||
| Slices for extension |
Content/Rules for all slices | |||
| extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| value[x]:valueString |
0..1 | string | Actual result | |
| dataAbsentReason |
0..0 | Why the result is missing | ||
| interpretation |
||||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/ValueSet/observation-interpretation (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| display |
0..0 | Representation defined by the system | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| note |
0..1 | Annotation | Comments about the observation | |
| bodySite |
0..0 | Observed body part | ||
| method |
0..0 | How it was done | ||
| specimen |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| display |
0..0 | Text alternative for the resource | ||
| device |
0..0 | (Measurement) Device | ||
| referenceRange |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| low |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| unit |
0..0 | Unit representation | ||
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| high |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| unit |
0..0 | Unit representation | ||
| system |
0..0 | System that defines coded unit form | ||
| code |
0..0 | Coded form of the unit | ||
| type |
0..0 | Reference range qualifier | ||
| appliesTo |
0..0 | Reference range population | ||
| age |
0..0 | Applicable age range, if relevant | ||
| hasMember |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| derivedFrom |
0..0 | Related measurements the observation is made from | ||
| component |
0..0 | Component results | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 | ||||
| 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: CommonLanguages (preferred): 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:requesterSigningStatus |
0..* | string | signed | unsigned URL: http://dips.no/fhir/observation/requester-signing-status-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.3.6.1.4.1.9038.62 (no extensions allowed) | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| status |
1..1 | code | registered | preliminary | final | amended | cancelled | enteredInError Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||
| coding:kithCoding |
0..* | Coding | Code defined by a terminology system | |||||
| 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: urn:oid:2.16.578.1.12.4.1.1.7280 (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| coding:dipsCoding |
0..* | Coding | Code defined by a terminology system | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.61.1 (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
0..1 | Reference(DIPSObservationSubjectReference) | Who and/or what the observation is about | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
0..1 | string | The value that is unique Example General: 123456 | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| effective[x] |
0..1 | dateTime | Clinically relevant time/time-period for observation | |||||
| performer |
0..* | Reference(DIPSBasisPractitionerRoleR4Reference | DIPSBasisOrganizationR4Reference) | Who is responsible for the observation | |||||
| Slices for value[x] |
C | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
| valueQuantity |
Quantity | |||||||
| valueString |
string | |||||||
| value[x]:valueQuantity |
C | 0..1 | Quantity | Actual result | ||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:textResult |
0..1 | string | Extension URL: http://DIPS.no/fhir/StructureDefinition/TextResultObservation | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation | |||||
| value[x]:valueString |
C | 0..1 | string | Actual result | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| 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://hl7.org/fhir/ValueSet/observation-interpretation (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| note |
0..1 | Annotation | Comments about the observation | |||||
| specimen |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.value[x]:valueQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).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 Observation
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 4 elements
Prohibited: 56 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Read Operation:
SHALL support reading Observation using its resource id:
GET [base]/Observation/[id]
Example:
Implementation Notes: Fetches the laboratory Observation resource that matches the given resource reference id.
Search Parameters:
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching Observation using the _id search parameter:
GET [base]/Observation?_id=[id]
Example:
Implementation Notes: Fetches a bundle of Observation resources matching the given logical id. Supports a comma separated list of ids.
SHALL support searching Observation using the patient.identifier search parameter, where the value is the patient identifier without a system:
GET [base]/Observation?patient.identifier=[value]
Example:
Implementation Notes: Fetches a bundle of all laboratory Observation resources for the patient with the given identifier ([how to search by token])
SHALL support searching Observation using the subject:patient.identifier search parameter, where the value is the patient identifier qualified with its system:
GET [base]/Observation?subject:patient.identifier=[system]|[value]
Example:
| GET [base]/Observation?subject:patient.identifier=urn:oid:2.16.578.1.12.4.1.4.1 | 15076500565 |
Implementation Notes: Fetches a bundle of all laboratory Observation resources for the patient with the given system-qualified identifier ([how to search by token])
SHALL support searching Observation using the subject search parameter:
GET [base]/Observation?subject=[id]
Example:
Implementation Notes: Fetches a bundle of all laboratory Observation resources for the patient referenced by the given logical id ([how to search by reference])
SHALL support searching Observation using the category search parameter:
GET [base]/Observation?category=[code]
Example:
Implementation Notes: Fetches a bundle of all laboratory Observation resources matching the given category ([how to search by token])
SHALL support searching Observation using the status search parameter:
GET [base]/Observation?status=[status]
Example:
Implementation Notes: Fetches a bundle of all laboratory Observation resources with the given status. The service matches this parameter name case-sensitively and maps the value onto the Observation status enumeration.
SHALL support searching Observation using the _lastupdated search parameter:
GET [base]/Observation?_lastupdated=[date]
Example:
Implementation Notes: Fetches a bundle of all laboratory Observation resources changed since the given time ([how to search by date])