HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-lab-rep-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/Observation-obl-uv-lab | Version: 1.0.0-ballot | |||
| Standards status: Informative | Maturity Level: 0 | Computable Name: ObservationUvLabObligations | ||
This profile defines obligations for Observation in FHIR for the purpose of this guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationResultsUvLab
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
   extension:supportingInfo |
O | 0..* | SupportingInfo(5.1.0) | Other information that may be relevant to this event.
| ||||||||
 extension:triggeredBy-r5 |
O | 0..* | R5 Observation.triggeredBy | Extension
| ||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:observation |
O | 0..* | Extension | Extension
| ||||||||
 extension:type |
O | 0..* | Extension | Extension
| ||||||||
  status |
O | 1..1 | code | Status of this observation (e.g. preliminary, final,...)
| ||||||||
| category |
O | 1..* | CodeableConceptIPS | Classification of type of observation
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| subject |
O | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| effective[x] |
O | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation
| ||||||||
 Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:data-absent-reason |
O | 0..1 | DataAbsentReason(5.1.0) | unknown | asked | temp | notasked | masked | unsupported | astext | error
| ||||||||
| issued |
O | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
O | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:performerFunction |
O | 0..* | PerformerFunction(5.1.0) | Type of performance
| ||||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| hasMember |
O | 0..* | Reference(Observation Results: laboratory) | Related resource that belongs to the Observation group
| ||||||||
| component |
O | 0..* | BackboneElement | Laboratory result
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
 value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study 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 uv-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" uv-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" | ||||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| supportingInfo |
O | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
| ||||||||
 triggeredBy-r5 |
O | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
| ||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
 extension:observation |
O | 0..* | Extension | Extension
| ||||||||
  extension |
0..0 | |||||||||||
| url |
1..1 | uri | "observation" | |||||||||
  value[x] |
1..1 | Reference(Observation) | Value of extension | |||||||||
| extension:type |
O | 0..* | Extension | Extension
| ||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "type" | |||||||||
| value[x] |
1..1 | code | Value of extension | |||||||||
| extension:reason |
0..* | Extension | Extension | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "reason" | |||||||||
| value[x] |
1..1 | string | Value of extension | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||||||
| certifiedRefMaterialCodeable |
0..* | CodeableConcept | Certified Reference Material: CodeableConcept URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialCodeable Binding: Laboratory Certified Reference Material (example) | |||||||||
| certifiedRefMaterialIdentifer |
0..* | Identifier | Certified Reference Material: Identifier URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialIdentifer | |||||||||
| labTestKit |
0..* | Reference(Device) | Device Laboratory Test Kit URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-deviceLabTestKit | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
 value[x] |
1..1 | Attachment | Value of extension | |||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!OΣ | 1..1 | code | Status of this observation (e.g. preliminary, final,...) Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||||
| Slices for category |
O | 1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| category:laboratory |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |||||||||
| category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Code (preferred)
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
 effective[x] |
OΣ | 1..1 | Clinically relevant time/time-period for observation
| |||||||||
| effective[x]All Types |
Content/Rules for all Types | |||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| data-absent-reason |
O | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| issued |
OΣ | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
OΣ | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| performerFunction |
O | 0..* | CodeableConcept | Type of performance URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction Binding: Performer Function Codes (extensible)
| ||||||||
| Slices for value[x] |
OΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
ΣC | 0..1 | string | Actual result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
ΣC | 0..1 | time | Actual result | ||||||||
| value[x]:valueDateTime |
ΣC | 0..1 | dateTime | Actual result | ||||||||
| value[x]:valuePeriod |
ΣC | 0..1 | Period | Actual result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Techniques (preferred)
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| hasMember |
OΣ | 0..* | Reference(Observation Results: laboratory) | Related resource that belongs to the Observation group
| ||||||||
| component |
OΣ | 0..* | BackboneElement | Laboratory result
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Laboratory Observation - IPS (preferred)
| ||||||||
| Slices for value[x] |
OΣ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
Σ | 0..1 | string | Actual component result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
Σ | 0..1 | time | Actual component result | ||||||||
| value[x]:valueDateTime |
Σ | 0..1 | dateTime | Actual component result | ||||||||
| value[x]:valuePeriod |
Σ | 0..1 | Period | Actual component result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||
| Observation.status | required | ObservationStatushttp://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.category:laboratory | preferred | Pattern: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||
| Observation.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||||||||||
| Observation.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||||||||||
| Observation.code | preferred | LaboratoryResultStandardVshttp://hl7.org/fhir/uv/lab-report/ValueSet/obsCode-uv-labfrom this IG | ||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||||||||||
| Observation.method | preferred | LabTechniqueVshttp://hl7.org/fhir/uv/lab-report/ValueSet/technique-uv-labfrom this IG | ||||||||||||
| Observation.component.code | preferred | ResultsLaboratoryObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips | ||||||||||||
| Observation.component.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips |
| 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() | |
| qty-3 | error | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.value[x]:valueRatio, Observation.component.value[x]:valueRatio | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.value[x]:valueRange, Observation.component.value[x]:valueRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| uv-lab-1 | error | Observation | If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| uv-lab-2 | error | Observation | If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study 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 uv-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" uv-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" | ||||||||
| 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 | Laboratory Test Kit Slice: Unordered, Open by value:url | |||||||||
| supportingInfo |
O | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
| ||||||||
| triggeredBy-r5 |
O | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| extension:observation |
O | 0..* | 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) | Value of extension | |||||||||
| extension:type |
O | 0..* | 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 | Value of extension | |||||||||
| extension:reason |
0..* | 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 | Value of extension | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||||||
| certifiedRefMaterialCodeable |
0..* | CodeableConcept | Certified Reference Material: CodeableConcept URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialCodeable Binding: Laboratory Certified Reference Material (example) | |||||||||
| certifiedRefMaterialIdentifer |
0..* | Identifier | Certified Reference Material: Identifier URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialIdentifer | |||||||||
| labTestKit |
0..* | Reference(Device) | Device Laboratory Test Kit URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-deviceLabTestKit | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| 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 |
?!OΣ | 1..1 | code | Status of this observation (e.g. preliminary, final,...) Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||||
| Slices for category |
O | 1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| category:laboratory |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..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 |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| 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 | |||||||||
| category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |||||||||
| category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Code (preferred)
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| 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 | 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 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| 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] |
OΣ | 1..1 | Clinically relevant time/time-period for observation
| |||||||||
| effective[x]All Types |
Content/Rules for all Types | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| data-absent-reason |
O | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| issued |
OΣ | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
OΣ | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| performerFunction |
O | 0..* | CodeableConcept | Type of performance URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction Binding: Performer Function Codes (extensible)
| ||||||||
| 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 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Slices for value[x] |
OΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
ΣC | 0..1 | string | Actual result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
ΣC | 0..1 | time | Actual result | ||||||||
| value[x]:valueDateTime |
ΣC | 0..1 | dateTime | Actual result | ||||||||
| value[x]:valuePeriod |
ΣC | 0..1 | Period | Actual result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Provides a reason why the expected value is missing. Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Techniques (preferred)
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | Measuring instrument | |||||||||
| 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 |
OΣ | 0..* | Reference(Observation Results: laboratory) | 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 |
OΣ | 0..* | BackboneElement | Laboratory result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Laboratory Observation - IPS (preferred)
| ||||||||
| Slices for value[x] |
OΣ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
Σ | 0..1 | string | Actual component result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
Σ | 0..1 | time | Actual component result | ||||||||
| value[x]:valueDateTime |
Σ | 0..1 | dateTime | Actual component result | ||||||||
| value[x]:valuePeriod |
Σ | 0..1 | Period | Actual component result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| 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.status | required | ObservationStatushttp://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.category:laboratory | preferred | Pattern: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||
| Observation.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||||||||||
| Observation.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||||||||||
| Observation.code | preferred | LaboratoryResultStandardVshttp://hl7.org/fhir/uv/lab-report/ValueSet/obsCode-uv-labfrom this IG | ||||||||||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||||||||
| Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| 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 | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||||||||||
| Observation.method | preferred | LabTechniqueVshttp://hl7.org/fhir/uv/lab-report/ValueSet/technique-uv-labfrom this IG | ||||||||||||
| 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 | ResultsLaboratoryObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips | ||||||||||||
| Observation.component.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| 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() | |
| qty-3 | error | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.value[x]:valueRatio, Observation.component.value[x]:valueRatio | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.value[x]:valueRange, Observation.component.value[x]:valueRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| uv-lab-1 | error | Observation | If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| uv-lab-2 | error | Observation | If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists() |
This structure is derived from ObservationResultsUvLab
Differential View
This structure is derived from ObservationResultsUvLab
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:supportingInfo |
O | 0..* | SupportingInfo(5.1.0) | Other information that may be relevant to this event.
| ||||||||
| extension:triggeredBy-r5 |
O | 0..* | R5 Observation.triggeredBy | Extension
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:observation |
O | 0..* | Extension | Extension
| ||||||||
| extension:type |
O | 0..* | Extension | Extension
| ||||||||
| status |
O | 1..1 | code | Status of this observation (e.g. preliminary, final,...)
| ||||||||
| category |
O | 1..* | CodeableConceptIPS | Classification of type of observation
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| subject |
O | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| effective[x] |
O | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:data-absent-reason |
O | 0..1 | DataAbsentReason(5.1.0) | unknown | asked | temp | notasked | masked | unsupported | astext | error
| ||||||||
| issued |
O | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
O | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:performerFunction |
O | 0..* | PerformerFunction(5.1.0) | Type of performance
| ||||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result
| ||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| hasMember |
O | 0..* | Reference(Observation Results: laboratory) | Related resource that belongs to the Observation group
| ||||||||
| component |
O | 0..* | BackboneElement | Laboratory result
| ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text
| ||||||||
| value[x] |
O | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result
| ||||||||
| Documentation for this format | ||||||||||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study 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 uv-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" uv-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| supportingInfo |
O | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
| ||||||||
| triggeredBy-r5 |
O | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:observation |
O | 0..* | Extension | Extension
| ||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "observation" | |||||||||
| value[x] |
1..1 | Reference(Observation) | Value of extension | |||||||||
| extension:type |
O | 0..* | Extension | Extension
| ||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "type" | |||||||||
| value[x] |
1..1 | code | Value of extension | |||||||||
| extension:reason |
0..* | Extension | Extension | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "reason" | |||||||||
| value[x] |
1..1 | string | Value of extension | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||||||
| certifiedRefMaterialCodeable |
0..* | CodeableConcept | Certified Reference Material: CodeableConcept URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialCodeable Binding: Laboratory Certified Reference Material (example) | |||||||||
| certifiedRefMaterialIdentifer |
0..* | Identifier | Certified Reference Material: Identifier URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialIdentifer | |||||||||
| labTestKit |
0..* | Reference(Device) | Device Laboratory Test Kit URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-deviceLabTestKit | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!OΣ | 1..1 | code | Status of this observation (e.g. preliminary, final,...) Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||||
| Slices for category |
O | 1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| category:laboratory |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |||||||||
| category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Code (preferred)
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| effective[x] |
OΣ | 1..1 | Clinically relevant time/time-period for observation
| |||||||||
| effective[x]All Types |
Content/Rules for all Types | |||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| data-absent-reason |
O | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| issued |
OΣ | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
OΣ | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| performerFunction |
O | 0..* | CodeableConcept | Type of performance URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction Binding: Performer Function Codes (extensible)
| ||||||||
| Slices for value[x] |
OΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
ΣC | 0..1 | string | Actual result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
ΣC | 0..1 | time | Actual result | ||||||||
| value[x]:valueDateTime |
ΣC | 0..1 | dateTime | Actual result | ||||||||
| value[x]:valuePeriod |
ΣC | 0..1 | Period | Actual result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Techniques (preferred)
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| hasMember |
OΣ | 0..* | Reference(Observation Results: laboratory) | Related resource that belongs to the Observation group
| ||||||||
| component |
OΣ | 0..* | BackboneElement | Laboratory result
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Laboratory Observation - IPS (preferred)
| ||||||||
| Slices for value[x] |
OΣ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
Σ | 0..1 | string | Actual component result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
Σ | 0..1 | time | Actual component result | ||||||||
| value[x]:valueDateTime |
Σ | 0..1 | dateTime | Actual component result | ||||||||
| value[x]:valuePeriod |
Σ | 0..1 | Period | Actual component result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||||||||||
| Observation.status | required | ObservationStatushttp://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.category:laboratory | preferred | Pattern: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||
| Observation.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||||||||||
| Observation.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||||||||||
| Observation.code | preferred | LaboratoryResultStandardVshttp://hl7.org/fhir/uv/lab-report/ValueSet/obsCode-uv-labfrom this IG | ||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||||||||||
| Observation.method | preferred | LabTechniqueVshttp://hl7.org/fhir/uv/lab-report/ValueSet/technique-uv-labfrom this IG | ||||||||||||
| Observation.component.code | preferred | ResultsLaboratoryObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips | ||||||||||||
| Observation.component.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips |
| 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() | |
| qty-3 | error | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.value[x]:valueRatio, Observation.component.value[x]:valueRatio | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.value[x]:valueRange, Observation.component.value[x]:valueRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| uv-lab-1 | error | Observation | If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| uv-lab-2 | error | Observation | If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvLab | Laboratory result for a simple test or for a panel/study 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 uv-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" uv-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" | ||||||||
| 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 | Laboratory Test Kit Slice: Unordered, Open by value:url | |||||||||
| supportingInfo |
O | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
| ||||||||
| triggeredBy-r5 |
O | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| extension:observation |
O | 0..* | 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) | Value of extension | |||||||||
| extension:type |
O | 0..* | 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 | Value of extension | |||||||||
| extension:reason |
0..* | 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 | Value of extension | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" | |||||||||
| certifiedRefMaterialCodeable |
0..* | CodeableConcept | Certified Reference Material: CodeableConcept URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialCodeable Binding: Laboratory Certified Reference Material (example) | |||||||||
| certifiedRefMaterialIdentifer |
0..* | Identifier | Certified Reference Material: Identifier URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-certifiedRefMaterialIdentifer | |||||||||
| labTestKit |
0..* | Reference(Device) | Device Laboratory Test Kit URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/observation-deviceLabTestKit | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| 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 |
?!OΣ | 1..1 | code | Status of this observation (e.g. preliminary, final,...) Binding: ObservationStatus (required): Codes providing the status of an observation.
| ||||||||
| Slices for category |
O | 1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
| ||||||||
| category:laboratory |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..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 |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| 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 | |||||||||
| category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |||||||||
| category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Code (preferred)
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient: Animal | Patient: Person | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| 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 | 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 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| 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] |
OΣ | 1..1 | Clinically relevant time/time-period for observation
| |||||||||
| effective[x]All Types |
Content/Rules for all Types | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| data-absent-reason |
O | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| issued |
OΣ | 0..1 | instant | Date/Time this result was made available
| ||||||||
| performer |
OΣ | 1..* | Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson) | Who is responsible for the observation
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| performerFunction |
O | 0..* | CodeableConcept | Type of performance URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction Binding: Performer Function Codes (extensible)
| ||||||||
| 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 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Slices for value[x] |
OΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
ΣC | 0..1 | string | Actual result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
ΣC | 0..1 | time | Actual result | ||||||||
| value[x]:valueDateTime |
ΣC | 0..1 | dateTime | Actual result | ||||||||
| value[x]:valuePeriod |
ΣC | 0..1 | Period | Actual result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Provides a reason why the expected value is missing. Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||||||
| interpretation |
O | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
| ||||||||
| note |
0..* | Annotation | Comments about the observation | |||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||||||
| method |
O | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Laboratory Techniques (preferred)
| ||||||||
| specimen |
O | 0..1 | Reference(Specimen: Laboratory) | Specimen used for this observation
| ||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | Measuring instrument | |||||||||
| 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 |
OΣ | 0..* | Reference(Observation Results: laboratory) | 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 |
OΣ | 0..* | BackboneElement | Laboratory result
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| value-r5 |
0..1 | (Complex) | only for result of type Attachment URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]" | |||||||||
| value[x] |
1..1 | Attachment | Value of extension | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| code |
O | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Laboratory Observation - IPS (preferred)
| ||||||||
| Slices for value[x] |
OΣ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this
| |||||||||
| valueQuantity |
Quantity | |||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||
| valueString |
string | |||||||||||
| valueBoolean |
boolean | |||||||||||
| valueInteger |
integer | |||||||||||
| valueRange |
Range | |||||||||||
| valueRatio |
Ratio | |||||||||||
| valueSampledData |
SampledData | |||||||||||
| valueTime |
time | |||||||||||
| valueDateTime |
dateTime | |||||||||||
| valuePeriod |
Period | |||||||||||
| value[x]:valueString |
Σ | 0..1 | string | Actual component result | ||||||||
| value[x]:valueRange |
C | 0..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||||||
| value[x]:valueRatio |
C | 0..1 | RatioUvLab | A measured ratio using UCUM rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||||||
| value[x]:valueTime |
Σ | 0..1 | time | Actual component result | ||||||||
| value[x]:valueDateTime |
Σ | 0..1 | dateTime | Actual component result | ||||||||
| value[x]:valuePeriod |
Σ | 0..1 | Period | Actual component result | ||||||||
| value[x]:valueQuantity |
C | 0..1 | QuantityUvLab | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||||||
| value[x]:valueCodeableConcept |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Coded Values Laboratory - IPS (preferred)
| |||||||||
| 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.status | required | ObservationStatushttp://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.category:laboratory | preferred | Pattern: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||||||||||
| Observation.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||||||||||
| Observation.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||||||||||
| Observation.code | preferred | LaboratoryResultStandardVshttp://hl7.org/fhir/uv/lab-report/ValueSet/obsCode-uv-labfrom this IG | ||||||||||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||||||||
| Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||||||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| 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 | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||||||||||
| Observation.method | preferred | LabTechniqueVshttp://hl7.org/fhir/uv/lab-report/ValueSet/technique-uv-labfrom this IG | ||||||||||||
| 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 | ResultsLaboratoryObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips | ||||||||||||
| Observation.component.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips | ||||||||||||
| 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() | |
| qty-3 | error | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.value[x]:valueRatio, Observation.component.value[x]:valueRatio | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.value[x]:valueRange, Observation.component.value[x]:valueRange | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| uv-lab-1 | error | Observation | If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| uv-lab-2 | error | Observation | If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists() |
This structure is derived from ObservationResultsUvLab
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Orders and Observations. Package hl7.fhir.uv.lab-report#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-08-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change