HL7 FHIR Implementation Guide Laboratory Report
0.2.0 - trial-use Italy flag

HL7 FHIR Implementation Guide Laboratory Report, published by HL7 Italia. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-it/lab-report/ and changes regularly. See the Directory of published versions

Resource Profile: Observation battery - Lab Report

Official URL: http://hl7.it/fhir/lab-report/StructureDefinition/observation-grouping-it-lab Version: 0.2.0
Standards status: Trial-use Maturity Level: 1 Computable Name: ObservationGroupingRefertoLabIt

Descrizione di un inseme di esami tramite il profilo della risorsa Observation per il referto di laboratorio.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 0..* Extension Triggering observation.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Value of extension
...... extension:type 0..* Extension The type of trigger
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 code Value of extension
...... extension:reason 0..* Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... 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"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension: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 Extension
Slice: Unordered, Open by value:url
..... 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
... Slices for category 1..* CodeableConceptIPS Codice che classifica il tipo di osservazione.
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Indica genericamente che si riferisce ad un esame di Laboratorio
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 Classificazione per tipo di studio
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept Classificazione per specialità
Binding: Laboratory Specialty (required)
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... subject Σ 1..1 Reference(Patient - Lab Report) Soggetto della rilevazione clinica.
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] Σ 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
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 1..* Reference(Practitioner - Lab Report | PractitionerRole - Lab Report | Organization - Lab Report | CareTeam | RelatedPerson) Soggetto responsabile dell'osservazione.
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..* CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... hasMember Σ 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📦4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.category:specialty Base required Laboratory Specialty 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
eu-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()
eu-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()
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.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.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.component.value[x]:valueRange If present, low SHALL have a lower value than high low.empty() or high.empty() or (low <= high)

This structure is derived from ObservationRefertoLabIt

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... value[x] 0..0 Risultato dell'osservazione.
... Slices for value[x] Content/Rules for all slices
.... value[x]:valueString 0..0 Actual result
.... value[x]:valueRange 0..0 Set of values bounded by low and high
.... value[x]:valueRatio 0..0 A measured ratio using UCUM
.... value[x]:valueTime 0..0 Actual result
.... value[x]:valueDateTime 0..0 Actual result
.... value[x]:valuePeriod 0..0 Actual result
.... value[x]:valueQuantity 0..0 Risultato misurabile tramite una quantità.
.... value[x]:valueCodeableConcept 0..0 Concept - reference to a terminology or just text
... referenceRange 0..0 Range di riferimento per la caratterizzazione dell'osservazione sulla base di un criterio. Esempio: Range di normalità per uomo adulto.
... hasMember 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.
... component 0..0 Laboratory result

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Optional Extensions Element
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 0..* Extension Triggering observation.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Value of extension
...... extension:type 0..* Extension The type of trigger
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... 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 Extension
Slice: Unordered, Open by value:url
....... 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"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension: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 Extension
Slice: Unordered, Open by value:url
..... 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 ?!Σ 1..1 code Descrizione attributo: Stato dell'osservazione. Possibili valori: registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category 1..* CodeableConceptIPS Codice che classifica il tipo di osservazione.
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Indica genericamente che si riferisce ad un esame di Laboratorio
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 Classificazione per tipo di studio
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept Classificazione per specialità
Binding: Laboratory Specialty (required)
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... subject Σ 1..1 Reference(Patient - Lab Report) Soggetto della rilevazione clinica.
.... 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 - Lab Report) Contesto in cui è stata prodotta l'osservazione.
... effective[x] Σ 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
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(Practitioner - Lab Report | PractitionerRole - Lab Report | Organization - Lab Report | CareTeam | RelatedPerson) Soggetto responsabile dell'osservazione.
.... 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:performerFunction 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
... 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.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Sito corporeo dell'osservazione.
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConceptIPS Metodo di rilevazione dell'osservazione.
Binding: ObservationMethods (preferred)
... specimen 0..1 Reference(Specimen - Lab Report) Reference al campione su cui si basa l'osservazione.
... device 0..1 Reference(Device - Lab Report | DeviceMetric) Dispositivo utilizzato per ottenere l'osservazione.
... hasMember Σ 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.
... derivedFrom Σ 0..* Reference(Observation - Lab Report | Media - Lab Report) Reference dell'osservazione da cui deriva questo valore di osservazione. Ad esempio, un gap anionico calcolato o una misurazione fetale basata su un'immagine ecografica.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📦4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.category:specialty Base required Laboratory Specialty 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG
Observation.subject.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base preferred Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
eu-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()
eu-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()
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.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.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.component.value[x]:valueRange If present, low SHALL have a lower value than high low.empty() or high.empty() or (low <= high)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 0..* Extension Triggering observation.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Value of extension
...... extension:type 0..* Extension The type of trigger
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 code Value of extension
...... extension:reason 0..* Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... 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"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension: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 Extension
Slice: Unordered, Open by value:url
..... 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
... Slices for category 1..* CodeableConceptIPS Codice che classifica il tipo di osservazione.
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Indica genericamente che si riferisce ad un esame di Laboratorio
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 Classificazione per tipo di studio
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept Classificazione per specialità
Binding: Laboratory Specialty (required)
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... subject Σ 1..1 Reference(Patient - Lab Report) Soggetto della rilevazione clinica.
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] Σ 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
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 1..* Reference(Practitioner - Lab Report | PractitionerRole - Lab Report | Organization - Lab Report | CareTeam | RelatedPerson) Soggetto responsabile dell'osservazione.
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..* CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... hasMember Σ 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📦4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.category:specialty Base required Laboratory Specialty 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
eu-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()
eu-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()
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.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.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.component.value[x]:valueRange If present, low SHALL have a lower value than high low.empty() or high.empty() or (low <= high)

Differential View

This structure is derived from ObservationRefertoLabIt

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... value[x] 0..0 Risultato dell'osservazione.
... Slices for value[x] Content/Rules for all slices
.... value[x]:valueString 0..0 Actual result
.... value[x]:valueRange 0..0 Set of values bounded by low and high
.... value[x]:valueRatio 0..0 A measured ratio using UCUM
.... value[x]:valueTime 0..0 Actual result
.... value[x]:valueDateTime 0..0 Actual result
.... value[x]:valuePeriod 0..0 Actual result
.... value[x]:valueQuantity 0..0 Risultato misurabile tramite una quantità.
.... value[x]:valueCodeableConcept 0..0 Concept - reference to a terminology or just text
... referenceRange 0..0 Range di riferimento per la caratterizzazione dell'osservazione sulla base di un criterio. Esempio: Range di normalità per uomo adulto.
... hasMember 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.
... component 0..0 Laboratory result

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationRefertoLabIt Observation battery Referto di Laboratorio
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Optional Extensions Element
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 0..* Extension Triggering observation.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Value of extension
...... extension:type 0..* Extension The type of trigger
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... 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 Extension
Slice: Unordered, Open by value:url
....... 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"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension: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 Extension
Slice: Unordered, Open by value:url
..... 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 ?!Σ 1..1 code Descrizione attributo: Stato dell'osservazione. Possibili valori: registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category 1..* CodeableConceptIPS Codice che classifica il tipo di osservazione.
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Indica genericamente che si riferisce ad un esame di Laboratorio
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 Classificazione per tipo di studio
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept Classificazione per specialità
Binding: Laboratory Specialty (required)
... code 1..1 CodeableConceptIPS Codice che identifica la tipologia dell'insieme di esami.
Binding: Sezioni Composition Lab Report (preferred)
... subject Σ 1..1 Reference(Patient - Lab Report) Soggetto della rilevazione clinica.
.... 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 - Lab Report) Contesto in cui è stata prodotta l'osservazione.
... effective[x] Σ 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
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(Practitioner - Lab Report | PractitionerRole - Lab Report | Organization - Lab Report | CareTeam | RelatedPerson) Soggetto responsabile dell'osservazione.
.... 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:performerFunction 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
... 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.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Sito corporeo dell'osservazione.
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConceptIPS Metodo di rilevazione dell'osservazione.
Binding: ObservationMethods (preferred)
... specimen 0..1 Reference(Specimen - Lab Report) Reference al campione su cui si basa l'osservazione.
... device 0..1 Reference(Device - Lab Report | DeviceMetric) Dispositivo utilizzato per ottenere l'osservazione.
... hasMember Σ 1..* Reference(Observation - Lab Report) Osservazioni contenenti i risultati degli esami svolti.
... derivedFrom Σ 0..* Reference(Observation - Lab Report | Media - Lab Report) Reference dell'osservazione da cui deriva questo valore di osservazione. Ad esempio, un gap anionico calcolato o una misurazione fetale basata su un'immagine ecografica.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📦4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.category:specialty Base required Laboratory Specialty 📦0.1.0 HL7 Europe Laboratory Report v0.1
Observation.code Base preferred Sezioni Composition Lab Report 📦0.2.0 This IG
Observation.subject.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base preferred Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
eu-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()
eu-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()
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.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.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.component.value[x]:valueRange If present, low SHALL have a lower value than high low.empty() or high.empty() or (low <= high)

 

Other representations of profile: CSV, Excel, Schematron