Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-VitalSigns | Version: | |||
| Active as of 2023-12-12 | Computable Name: UKCoreObservationVitalSigns | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
Defines the observation constraints and extensions on the UK Core Observation resource for the minimal set of data to query and retrieve clinical observation vital signs information.
This profile allows exchange of internationally FHIR compliant vital signs information based on measurements and simple assertions made about an individual. Where a more constrained derived profile exists, it should be used instead of this profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" |
  Slices for extension |
Content/Rules for all slices | |||
   bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |
   value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |
 recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |
 status |
1..1 | code | A status of `final` SHALL be present. Fixed Value: final | |
| category |
1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. | |
 coding |
||||
 system |
0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
 code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |
| code |
1..1 | CodeableConcept | The type of vital signs observation (code / type). | |
| Slices for coding |
2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:loinc |
1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 coding:snomedCT |
1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| subject |
1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. | |
| effective[x] |
1..1 | dateTime, Period, Timing, instant | A clinically relevant time / time-period for observation SHALL be present. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | |
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| triggeredByR5 |
0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:observation |
1..1 | Extension | Extension | |
 extension |
0..0 | |||
| url |
1..1 | uri | "observation" | |
 value[x] |
1..1 | Reference(Observation) | Triggering observation. | |
| extension:type |
1..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | The type of trigger. Reflex | Repeat | Re-run Binding: observation-triggeredbytype (required) | |
| extension:reason |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "reason" | |
| value[x] |
1..1 | string | Reason that the observation was triggered. | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |
 bodyStructureR5 |
0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | |
| bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition" | |
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |
| recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | A status of `final` SHALL be present. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category |
S | 1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| code |
SΣ | 1..1 | CodeableConcept | The type of vital signs observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:loinc |
Σ | 1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| coding:snomedCT |
Σ | 1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| subject |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. |
 effective[x] |
SΣ | 1..1 | A clinically relevant time / time-period for observation SHALL be present. | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| effectiveTiming |
Timing | |||
| effectiveInstant |
instant | |||
| performer |
SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation. |
| value[x] |
SΣC | 0..1 | The actual observed result. | |
| valueQuantity |
Quantity | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueString |
string | |||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueSampledData |
SampledData | |||
| valueTime |
time | |||
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| component |
SΣ | 0..* | BackboneElement | Component / sub results. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.extension:triggeredByR5.extension:type.value[x] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | |
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | |
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG | |
| Observation.component.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| triggeredByR5 |
0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:observation |
1..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "observation" | |||||
| value[x] |
1..1 | Reference(Observation) | Triggering observation. | |||||
| extension:type |
1..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | The type of trigger. Reflex | Repeat | Re-run Binding: observation-triggeredbytype (required) | |||||
| extension:reason |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "reason" | |||||
| value[x] |
1..1 | string | Reason that the observation was triggered. | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||
| bodyStructureR5 |
0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | |||||
| bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |||||
| recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | A status of `final` SHALL be present. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| category |
S | 1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| 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 | ||||
| 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 | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | ||||
| 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 | ||||
| code |
SΣ | 1..1 | CodeableConcept | The type of vital signs observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of 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 | |||||
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:loinc |
Σ | 1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) | ||||
| 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 |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:snomedCT |
Σ | 1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of 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 |
Σ | 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 |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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 |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] |
SΣ | 1..1 | A clinically relevant time / time-period for observation SHALL be present. | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation. | ||||
| value[x] |
SΣC | 0..1 | The actual observed result. | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (preferred): 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 obs-3: Must have at least a low or a high or text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (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 | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
SΣ | 0..* | BackboneElement | Component / sub results. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.extension:triggeredByR5.extension:type.value[x] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | ||||
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | ||||
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
This structure is derived from UKCoreObservation
Summary
Mandatory: 7 elements
Fixed: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from UKCoreObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" |
| Slices for extension |
Content/Rules for all slices | |||
| bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |
| recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |
| status |
1..1 | code | A status of `final` SHALL be present. Fixed Value: final | |
| category |
1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |
| code |
1..1 | CodeableConcept | The type of vital signs observation (code / type). | |
| Slices for coding |
2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:loinc |
1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| coding:snomedCT |
1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| subject |
1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. | |
| effective[x] |
1..1 | dateTime, Period, Timing, instant | A clinically relevant time / time-period for observation SHALL be present. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | |
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| triggeredByR5 |
0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:observation |
1..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "observation" | |
| value[x] |
1..1 | Reference(Observation) | Triggering observation. | |
| extension:type |
1..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "type" | |
| value[x] |
1..1 | code | The type of trigger. Reflex | Repeat | Re-run Binding: observation-triggeredbytype (required) | |
| extension:reason |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "reason" | |
| value[x] |
1..1 | string | Reason that the observation was triggered. | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |
| bodyStructureR5 |
0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | |
| bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |
| recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | A status of `final` SHALL be present. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category |
S | 1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| code |
SΣ | 1..1 | CodeableConcept | The type of vital signs observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:loinc |
Σ | 1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| coding:snomedCT |
Σ | 1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| system |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| subject |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. |
| effective[x] |
SΣ | 1..1 | A clinically relevant time / time-period for observation SHALL be present. | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| effectiveTiming |
Timing | |||
| effectiveInstant |
instant | |||
| performer |
SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation. |
| value[x] |
SΣC | 0..1 | The actual observed result. | |
| valueQuantity |
Quantity | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueString |
string | |||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueSampledData |
SampledData | |||
| valueTime |
time | |||
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| component |
SΣ | 0..* | BackboneElement | Component / sub results. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.extension:triggeredByR5.extension:type.value[x] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | |
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | |
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | |
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG | |
| Observation.component.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | UKCoreObservation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present ukcore-obs-vs-001: `code.coding` SHALL include a LOINC "magic code" | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| triggeredByR5 |
0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:observation |
1..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "observation" | |||||
| value[x] |
1..1 | Reference(Observation) | Triggering observation. | |||||
| extension:type |
1..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "type" | |||||
| value[x] |
1..1 | code | The type of trigger. Reflex | Repeat | Re-run Binding: observation-triggeredbytype (required) | |||||
| extension:reason |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "reason" | |||||
| value[x] |
1..1 | string | Reason that the observation was triggered. | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||
| bodyStructureR5 |
0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | |||||
| bodyPosition |
0..1 | (Complex) | The patients body position when the vital signs observation was recorded. URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/observation-bodyPosition" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: UK Core Body Position (preferred) | |||||
| recordingSetting |
0..* | CodeableConcept | Records whether the vital signs observation was performed in a clinical or non clinical setting. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-RecordingSetting | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!SΣ | 1..1 | code | A status of `final` SHALL be present. Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| category |
S | 1..1 | CodeableConcept | A category of `vital-signs` SHALL be present. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| 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 | ||||
| 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 | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | ||||
| 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 | ||||
| code |
SΣ | 1..1 | CodeableConcept | The type of vital signs observation (code / type). Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of 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 | |||||
| Slices for coding |
Σ | 2..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:loinc |
Σ | 1..1 | Coding | A LOINC "magic code" describing the type of observation SHALL be present. Binding: VitalSigns (extensible) | ||||
| 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 |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:snomedCT |
Σ | 1..* | Coding | A SNOMED CT concept describing the type of observation SHALL be present. Binding: UK Core Observation Vital Signs Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of 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 |
Σ | 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 |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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 |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who or what the observation relates to SHALL be present. | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] |
SΣ | 1..1 | A clinically relevant time / time-period for observation SHALL be present. | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation. | ||||
| value[x] |
SΣC | 0..1 | The actual observed result. | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (preferred): 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 obs-3: Must have at least a low or a high or text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (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 | |||||
| hasMember |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
SΣ | 0..* | BackboneElement | Component / sub results. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.extension:triggeredByR5.extension:type.value[x] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | ||||
| Observation.extension:bodyPosition.value[x] | preferred | UKCoreBodyPositionhttps://fhir.hl7.org.uk/ValueSet/UKCore-BodyPositionfrom this IG | ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | ||||
| Observation.code.coding:loinc | extensible | VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresultfrom the FHIR Standard | ||||
| Observation.code.coding:snomedCT | preferred | UKCoreObservationVitalSignsTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationVitalSignsTypefrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | preferred | UKCoreObservationTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-ObservationTypefrom this IG | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ukcore-obs-vs-001 | error | Observation | `code.coding` SHALL include a LOINC "magic code" : code.coding.where(system='http://loinc.org').exists() |
This structure is derived from UKCoreObservation
Summary
Mandatory: 7 elements
Fixed: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron