International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

This page is part of the International Patient Summary Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Observation Results - Radiology (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-radiology-uv-ips Version: 2.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: ObservationResultsRadiologyUvIps

This profile represents the constraints applied to the Observation resource by the IPS project, which specifies a radiology observation for the international patient summary based on the FHIR standard R4.

This observation may represent the conclusions of a diagnostic procedure such a Chest RX, or it may group the set of results produced by that single or multi-modality procedure.

In the latter case, the main observation (this one) carries the overall conclusion of the study and/or a global interpretation by the observer of the study as value of this observation; and may reference the atomic results of the study as "child observations".

It allows also providing details about the related study using the partOf element referring to an ImagingStudy resource.

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..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, hasMemberOrComponent
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(ImagingStudy (IPS)) Part of referenced event
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... 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: imaging
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SOΣ 1..1 CodeableConceptIPS Type of observation (code / type)
Binding: Results Radiology Observation - IPS (preferred)
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... subject SOΣ 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
... Slices for effective[x] SOΣC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... performer SOΣ 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString SOΣC 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... hasMember Σ 0..* Reference(Observation Results - Radiology (IPS)) Related resource that belongs to the Observation group
... component SOΣ 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required Results Status Codes - IPS 📦2.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:radiology Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Radiology Component - IPS 📦2.0.0 This IG

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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8
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()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: hasMemberOrComponent
... partOf 0..* Reference(ImagingStudy (IPS)) Part of referenced event
... status 1..1 code registered | preliminary | final | amended +
Binding: Results Status Codes - IPS (required)
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imaging
... subject SO 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... reference SO 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
... Slices for effective[x] SOC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SO 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... performer SO 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Slice: Unordered, Open by type:$this
.... value[x]:valueString SO 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... bodySite 0..1 CodeableConcept Observed body part
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... hasMember 0..* Reference(Observation Results - Radiology (IPS)) Related resource that belongs to the Observation group
... component SO 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.status Base required Results Status Codes - IPS 📦2.0.0 This IG
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.component.​code Base preferred Results Radiology Component - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, hasMemberOrComponent
... 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
... extension 0..* Extension Additional content defined by implementations
... 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(ImagingStudy (IPS)) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: Results Status Codes - IPS (required)
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... 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: imaging
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SOΣ 1..1 CodeableConceptIPS Type of observation (code / type)
Binding: Results Radiology Observation - IPS (preferred)
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... subject SOΣ 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... Slices for effective[x] SOΣC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... issued Σ 0..1 instant Date/Time this version was made available
... performer SOΣ 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString SOΣC 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation Results - Radiology (IPS)) 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 SOΣ 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)
.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

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 Results Status Codes - IPS 📦2.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:radiology Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example 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 Radiology Component - IPS 📦2.0.0 This IG
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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, hasMemberOrComponent
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(ImagingStudy (IPS)) Part of referenced event
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... 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: imaging
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SOΣ 1..1 CodeableConceptIPS Type of observation (code / type)
Binding: Results Radiology Observation - IPS (preferred)
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... subject SOΣ 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
... Slices for effective[x] SOΣC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... performer SOΣ 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString SOΣC 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... hasMember Σ 0..* Reference(Observation Results - Radiology (IPS)) Related resource that belongs to the Observation group
... component SOΣ 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required Results Status Codes - IPS 📦2.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:radiology Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Radiology Component - IPS 📦2.0.0 This IG

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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8
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()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: hasMemberOrComponent
... partOf 0..* Reference(ImagingStudy (IPS)) Part of referenced event
... status 1..1 code registered | preliminary | final | amended +
Binding: Results Status Codes - IPS (required)
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imaging
... subject SO 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... reference SO 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
... Slices for effective[x] SOC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SO 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... performer SO 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Slice: Unordered, Open by type:$this
.... value[x]:valueString SO 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... bodySite 0..1 CodeableConcept Observed body part
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... hasMember 0..* Reference(Observation Results - Radiology (IPS)) Related resource that belongs to the Observation group
... component SO 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.status Base required Results Status Codes - IPS 📦2.0.0 This IG
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.component.​code Base preferred Results Radiology Component - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, hasMemberOrComponent
... 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
... extension 0..* Extension Additional content defined by implementations
... 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(ImagingStudy (IPS)) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: Results Status Codes - IPS (required)
... Slices for category 1..* CodeableConceptIPS Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:radiology SO 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... 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: imaging
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SOΣ 1..1 CodeableConceptIPS Type of observation (code / type)
Binding: Results Radiology Observation - IPS (preferred)
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... subject SOΣ 1..1 Reference(Patient (IPS)) Who and/or what the observation is about
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... Slices for effective[x] SOΣC 1..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Constraints: ips-1
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime Clinically relevant time/time-period for observation
ObligationsActor
SHOULD:able-to-populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... issued Σ 0..1 instant Date/Time this version was made available
... performer SOΣ 1..* Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) Who is responsible for the observation
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString SOΣC 0..1 string Actual result
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device - Performer or Observer (IPS)) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation Results - Radiology (IPS)) 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 SOΣ 0..* BackboneElement Component results
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: Results Radiology Component - IPS (preferred)
.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

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 Results Status Codes - IPS 📦2.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:radiology Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base preferred Results Radiology Observation - IPS 📦2.0.0 This IG
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example 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 Radiology Component - IPS 📦2.0.0 This IG
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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hasMemberOrComponent error Observation component and hasMember are mutually exclusive hasMember.empty() or component.empty()
ips-1 error Observation.effective[x] Datetime must be at least to day. $this.ofType(dateTime).empty() or ($this as dateTime).toString().length() >= 8
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron