Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.virtually.healthcare/StructureDefinition/Observation | Version: 0.1.0-current | |||
Draft as of 2024-11-20 | Computable Name: Observation |
Extension of UKCore-Observation and includes elements from HL7 International Patient Access
See Observation Definitions for clinical coding and units to be used with Observation.
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 | 0..* | UKCoreObservation | Measurements and simple assertions | |
contained | 0..0 | |||
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation |
code | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) | |
subject | ||||
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
effective[x] | 1..1 | dateTime | A clinically relevant time / time-period for observation. | |
performer | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. | |
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |
component | ||||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VH Observation Type (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | UKCoreObservation | Measurements and simple assertions 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 obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
triggeredByR5 | N | 0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy |
Slices for extension | N | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:observation | N | 1..1 | Extension | Triggering observation |
url | 1..1 | uri | "observation" | |
value[x] | N | 1..1 | Reference(Observation) | Triggering observation. |
extension:type | N | 1..1 | Extension | reflex | repeat | re-run Binding: observation-triggeredbytype (required) |
url | 1..1 | uri | "type" | |
value[x] | N | 1..1 | code | The type of trigger. Reflex | Repeat | Re-run |
extension:reason | N | 0..1 | Extension | Reason that the observation was triggered |
url | 1..1 | uri | "reason" | |
value[x] | N | 1..1 | string | Reason that the observation was triggered. |
url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |
bodyStructureR5 | N | 0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation |
status | ?!SΣ | 1..1 | code | The status of the result value. Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) |
subject | SΣC | 0..1 | Reference(Patient | Group | Device | Location) | Who and / or what the observation is about. ref-1: SHALL have a contained resource if a local reference is provided |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
effective[x] | SΣ | 1..1 | dateTime | A clinically relevant time / time-period for observation. |
performer | SΣC | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. ref-1: SHALL have a contained resource if a local reference is provided |
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |
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. |
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: VH Observation Type (extensible) |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.extension:triggeredByR5.extension:type [] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | UKCoreObservation | Measurements and simple assertions 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 obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | ||||
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 | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
triggeredByR5 | N | 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 | N | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
extension:observation | N | 1..1 | Extension | Triggering observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "observation" | |||||
value[x] | N | 1..1 | Reference(Observation) | Triggering observation. | ||||
extension:type | N | 1..1 | Extension | reflex | repeat | re-run Binding: observation-triggeredbytype (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "type" | |||||
value[x] | N | 1..1 | code | The type of trigger. Reflex | Repeat | Re-run | ||||
extension:reason | N | 0..1 | Extension | Reason that the observation was triggered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "reason" | |||||
value[x] | N | 1..1 | string | Reason that the observation was triggered. | ||||
url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||
bodyStructureR5 | N | 0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation | ||||
basedOn | ΣC | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order ref-1: SHALL have a contained resource if a local reference is provided | ||||
partOf | ΣC | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | ?!SΣ | 1..1 | code | The status of the result value. Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 0..* | CodeableConcept | A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
code | SΣ | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) | ||||
subject | SΣC | 0..1 | Reference(Patient | Group | Device | Location) | Who and / or what the observation is about. ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
focus | ΣC | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record ref-1: SHALL have a contained resource if a local reference is provided | ||||
encounter | ΣC | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made ref-1: SHALL have a contained resource if a local reference is provided | ||||
effective[x] | SΣ | 1..1 | dateTime | A clinically relevant time / time-period for observation. | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | SΣC | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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 | C | 0..1 | Reference(Specimen) | Specimen used for this observation ref-1: SHALL have a contained resource if a local reference is provided | ||||
device | C | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
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 | C | 0..1 | Range | Applicable age range, if relevant rng-2: If present, low SHALL have a lower value than high | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | ΣC | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group ref-1: SHALL have a contained resource if a local reference is provided | ||||
derivedFrom | ΣC | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from ref-1: SHALL have a contained resource if a local reference is provided | ||||
component | SΣ | 0..* | BackboneElement | Component / sub results. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VH Observation Type (extensible) | ||||
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 | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.extension:triggeredByR5.extension:type [] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | ||||
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from UKCoreObservation
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from UKCoreObservation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | UKCoreObservation | Measurements and simple assertions | |
contained | 0..0 | |||
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation |
code | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) | |
subject | ||||
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
effective[x] | 1..1 | dateTime | A clinically relevant time / time-period for observation. | |
performer | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. | |
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |
component | ||||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VH Observation Type (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | UKCoreObservation | Measurements and simple assertions 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 obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
triggeredByR5 | N | 0..* | (Complex) | Triggering observation(s). This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy |
Slices for extension | N | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:observation | N | 1..1 | Extension | Triggering observation |
url | 1..1 | uri | "observation" | |
value[x] | N | 1..1 | Reference(Observation) | Triggering observation. |
extension:type | N | 1..1 | Extension | reflex | repeat | re-run Binding: observation-triggeredbytype (required) |
url | 1..1 | uri | "type" | |
value[x] | N | 1..1 | code | The type of trigger. Reflex | Repeat | Re-run |
extension:reason | N | 0..1 | Extension | Reason that the observation was triggered |
url | 1..1 | uri | "reason" | |
value[x] | N | 1..1 | string | Reason that the observation was triggered. |
url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |
bodyStructureR5 | N | 0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation |
status | ?!SΣ | 1..1 | code | The status of the result value. Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) |
subject | SΣC | 0..1 | Reference(Patient | Group | Device | Location) | Who and / or what the observation is about. ref-1: SHALL have a contained resource if a local reference is provided |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
effective[x] | SΣ | 1..1 | dateTime | A clinically relevant time / time-period for observation. |
performer | SΣC | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. ref-1: SHALL have a contained resource if a local reference is provided |
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |
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. |
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: VH Observation Type (extensible) |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.extension:triggeredByR5.extension:type [] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | UKCoreObservation | Measurements and simple assertions 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 obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | ||||
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 | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
triggeredByR5 | N | 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 | N | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
extension:observation | N | 1..1 | Extension | Triggering observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "observation" | |||||
value[x] | N | 1..1 | Reference(Observation) | Triggering observation. | ||||
extension:type | N | 1..1 | Extension | reflex | repeat | re-run Binding: observation-triggeredbytype (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "type" | |||||
value[x] | N | 1..1 | code | The type of trigger. Reflex | Repeat | Re-run | ||||
extension:reason | N | 0..1 | Extension | Reason that the observation was triggered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
url | 1..1 | uri | "reason" | |||||
value[x] | N | 1..1 | string | Reason that the observation was triggered. | ||||
url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||
bodyStructureR5 | N | 0..1 | Reference(BodyStructure) | Observed body structure. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | S | 1..* | CommonResourceIdentifiers | An identifier intended for computation | ||||
basedOn | ΣC | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order ref-1: SHALL have a contained resource if a local reference is provided | ||||
partOf | ΣC | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | ?!SΣ | 1..1 | code | The status of the result value. Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 0..* | CodeableConcept | A code that classifies the general type of observation being made. Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
code | SΣ | 1..1 | CodeableConcept | The type of observation (code / type). Binding: VH Observation Type (extensible) | ||||
subject | SΣC | 0..1 | Reference(Patient | Group | Device | Location) | Who and / or what the observation is about. ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
focus | ΣC | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record ref-1: SHALL have a contained resource if a local reference is provided | ||||
encounter | ΣC | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made ref-1: SHALL have a contained resource if a local reference is provided | ||||
effective[x] | SΣ | 1..1 | dateTime | A clinically relevant time / time-period for observation. | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | SΣC | 1..* | Reference(Practitioner | Patient) | Who is responsible for the observation. ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | ProfessionalLicense, NHSNumbers, StaffEnterpriseNumber | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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 | C | 0..1 | Reference(Specimen) | Specimen used for this observation ref-1: SHALL have a contained resource if a local reference is provided | ||||
device | C | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
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 | C | 0..1 | Range | Applicable age range, if relevant rng-2: If present, low SHALL have a lower value than high | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | ΣC | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group ref-1: SHALL have a contained resource if a local reference is provided | ||||
derivedFrom | ΣC | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from ref-1: SHALL have a contained resource if a local reference is provided | ||||
component | SΣ | 0..* | BackboneElement | Component / sub results. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VH Observation Type (extensible) | ||||
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 | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.extension:triggeredByR5.extension:type [] | required | http://hl7.org/fhir/ValueSet/observation-triggeredbytypehttp://hl7.org/fhir/ValueSet/observation-triggeredbytype | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | ||||
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | VHObservationTypehttps://fhir.virtually.healthcare/ValueSet/VHObservationType from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from UKCoreObservation
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron