INCISIVE Implementation Guide
0.1.1 - draft

INCISIVE Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Observation for Lung cancer

Official URL: https://fhir.incisive-project.eu/StructureDefinition/ObservationForLung Version: 0.1.1
Draft as of 2024-03-19 Computable Name: ObservationForLung

Defines the Observation structure used by Lung cancer in the INCISIVE

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
... status 1..1codeStatus of this observation
... category 0..*CodeableConceptDescribe classification of lung cancer type or define the timepoint that this observation was taken
Binding: Cancer_Type_Codes (preferred): Cancer Type Codes

.... coding 0..*CodingCode defined by INCISIVE local codes
..... system 0..1uriIdentity of the INCISIVE local code system
..... code 0..1codeCancer Type code
..... display 0..1stringCancer Type description
.... text 0..1stringIndicate timepoint that this observation was taken
... code 1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... coding 0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... system 0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... code 0..1codeSNOMED CT code or Label Code
..... display 0..1stringSNOMED CT FSN or Label description
.... reference 0..1stringUse relative reference to the Patient resource
.... type 0..1uriType the resource reference refers to
... value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodDescribe date of this observation
... note 0..*AnnotationObservation notes
.... text 1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... coding 0..*CodingCode defined by INCISIVE local codes
..... system 0..1uriIdentity of the INCISIVE local code system
..... code 0..1codeLocation code
..... display 0..1stringLocation description
... component 0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... code 1..1CodeableConceptClassification of component observation
..... coding 0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... system 0..1uriIdentity of the SNOMED CT url or LOINC url
...... code 0..1codeSNOMED CT code or LOINC code
...... display 0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
.... value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
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
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeStatus of this observation
Binding: ObservationStatus (required): Codes providing the status of an observation.

.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... code Σ0..1codeCancer Type code
..... display Σ0..1stringCancer Type description
.... text Σ0..1stringIndicate timepoint that this observation was taken
... code Σ1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... coding Σ0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... system Σ0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... code Σ0..1codeSNOMED CT code or Label Code
..... display Σ0..1stringSNOMED CT FSN or Label description
... subject Σ0..1Reference(Patient | Group | Device | Location)Patient whose measurement has been made
.... reference ΣC0..1stringUse relative reference to the Patient resource
.... type Σ0..1uriType the resource reference refers to
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

... value[x] ΣC0..1Describe date of this observation
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... note 0..*AnnotationObservation notes
.... text Σ1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... code Σ0..1codeLocation code
..... display Σ0..1stringLocation description
... component Σ0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptClassification of component observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... coding Σ0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... system Σ0..1uriIdentity of the SNOMED CT url or LOINC url
...... code Σ0..1codeSNOMED CT code or LOINC code
...... display Σ0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
.... value[x] Σ0..1Actual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes

..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
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
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1codeStatus of this observation
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptDescribe classification of lung cancer type or define the timepoint that this observation was taken
Binding: Cancer_Type_Codes (preferred): Cancer Type Codes


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeCancer Type code
..... display Σ0..1stringCancer Type description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringIndicate timepoint that this observation was taken
... code Σ1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSNOMED CT code or Label Code
..... display Σ0..1stringSNOMED CT FSN or Label description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location)Patient whose measurement has been made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringUse relative reference to the Patient resource
.... type Σ0..1uriType the resource reference refers to
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣC0..1Describe date of this observation
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationObservation notes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeLocation code
..... display Σ0..1stringLocation description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptClassification of component observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the SNOMED CT url or LOINC url
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSNOMED CT code or LOINC code
...... display Σ0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x] Σ0..1Actual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes

..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
... status 1..1codeStatus of this observation
... category 0..*CodeableConceptDescribe classification of lung cancer type or define the timepoint that this observation was taken
Binding: Cancer_Type_Codes (preferred): Cancer Type Codes

.... coding 0..*CodingCode defined by INCISIVE local codes
..... system 0..1uriIdentity of the INCISIVE local code system
..... code 0..1codeCancer Type code
..... display 0..1stringCancer Type description
.... text 0..1stringIndicate timepoint that this observation was taken
... code 1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... coding 0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... system 0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... code 0..1codeSNOMED CT code or Label Code
..... display 0..1stringSNOMED CT FSN or Label description
.... reference 0..1stringUse relative reference to the Patient resource
.... type 0..1uriType the resource reference refers to
... value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodDescribe date of this observation
... note 0..*AnnotationObservation notes
.... text 1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... coding 0..*CodingCode defined by INCISIVE local codes
..... system 0..1uriIdentity of the INCISIVE local code system
..... code 0..1codeLocation code
..... display 0..1stringLocation description
... component 0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... code 1..1CodeableConceptClassification of component observation
..... coding 0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... system 0..1uriIdentity of the SNOMED CT url or LOINC url
...... code 0..1codeSNOMED CT code or LOINC code
...... display 0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
.... value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
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
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeStatus of this observation
Binding: ObservationStatus (required): Codes providing the status of an observation.

.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... code Σ0..1codeCancer Type code
..... display Σ0..1stringCancer Type description
.... text Σ0..1stringIndicate timepoint that this observation was taken
... code Σ1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... coding Σ0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... system Σ0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... code Σ0..1codeSNOMED CT code or Label Code
..... display Σ0..1stringSNOMED CT FSN or Label description
... subject Σ0..1Reference(Patient | Group | Device | Location)Patient whose measurement has been made
.... reference ΣC0..1stringUse relative reference to the Patient resource
.... type Σ0..1uriType the resource reference refers to
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

... value[x] ΣC0..1Describe date of this observation
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... note 0..*AnnotationObservation notes
.... text Σ1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... code Σ0..1codeLocation code
..... display Σ0..1stringLocation description
... component Σ0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptClassification of component observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... coding Σ0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... system Σ0..1uriIdentity of the SNOMED CT url or LOINC url
...... code Σ0..1codeSNOMED CT code or LOINC code
...... display Σ0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
.... value[x] Σ0..1Actual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes

..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements, simple assertions or information about diagnosis of a patient
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
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1codeStatus of this observation
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 0..*CodeableConceptDescribe classification of lung cancer type or define the timepoint that this observation was taken
Binding: Cancer_Type_Codes (preferred): Cancer Type Codes


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeCancer Type code
..... display Σ0..1stringCancer Type description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringIndicate timepoint that this observation was taken
... code Σ1..1CodeableConceptDescribe case use of this observation or label of this observation
Binding: Label_Codes (preferred): Label Codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a SNOMED CT terminology or INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the SNOMED CT terminology system or INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSNOMED CT code or Label Code
..... display Σ0..1stringSNOMED CT FSN or Label description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location)Patient whose measurement has been made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringUse relative reference to the Patient resource
.... type Σ0..1uriType the resource reference refers to
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣC0..1Describe date of this observation
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationObservation notes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownNotes content
... bodySite 0..1CodeableConceptDescribe observed body location
Binding: Location_Codes (preferred): Location Codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by INCISIVE local codes
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the INCISIVE local code system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeLocation code
..... display Σ0..1stringLocation description
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementResult of measurements, simple assertions or information about diagnosis of a patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptClassification of component observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a SNOMED CT or LOINC terminology
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the SNOMED CT url or LOINC url
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSNOMED CT code or LOINC code
...... display Σ0..1stringFully Specified Name defined by the SNOMED CT or name defined by the LOINC
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x] Σ0..1Actual observation component result
Binding: Lung_Component_Codes (preferred): Lung Component Codes

..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredCancer_Type_Codes
https://fhir.incisive-project.eu/ValueSet/CancerTypeCodes
from this IG
Observation.codepreferredLabel_Codes
https://fhir.incisive-project.eu/ValueSet/LabelCodes
from this IG
Observation.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySitepreferredLocation_Codes
https://fhir.incisive-project.eu/ValueSet/LocationCodes
from this IG
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.value[x]preferredLung_Component_Codes
https://fhir.incisive-project.eu/ValueSet/LungComponentCodes
from this IG
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

 

Other representations of profile: CSV, Excel, Schematron

INCISIVE has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 952179. However, the content of this website reflects the opinion of its authors and does not in any way represent opinions of the European Union. European Commission is not responsible for any use that may be made of the information the website contains.
https://ec.europa.eu/digital-single-market/en/policies/ehealth