International Patient Summary Implementation Guide
1.1.0 - CI Build
International Patient Summary Implementation Guide
1.1.0 - CI Build
International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-radiology-uv-ips | Version: 1.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | 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 references 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationResultsUvIps
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions hasMemberOrComponent: component and hasMember are mutually exclusive |
  partOf |
0..* | Reference(Imaging Study (IPS)) | Part of referenced event | |
 status |
1..1 | code | registered | preliminary | final | amended + Fixed Value: final | |
  Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this | |
   category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
 code |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| subject |
S | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about |
| effective[x] |
SC | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. |
| performer |
S | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation |
 valueString |
S | 0..1 | string | Actual result |
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| device |
0..1 | Reference(Device - performer, observer) | (Measurement) Device | |
| hasMember |
0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group | |
| reference |
0..1 | string | Literal reference, Relative, internal or absolute URL | |
 Slices for component |
S | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value |
 component:observationText |
0..* | BackboneElement | Observation Text | |
  code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |
 value[x] |
1..1 | string | Actual component result | |
| component:observationCode |
0..* | BackboneElement | Observation Code | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| component:numericQuantityMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | QuantityIPS | A measured amount using UCUM | |
| component:numericRangeMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | RangeIPS | Set of values bounded by low and high | |
| component:numericRatioMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator | |
| component:numericSampledDataMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | SampledData | Actual component result | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | |
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions 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 hasMemberOrComponent: component and hasMember are mutually exclusive |
| 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(Imaging Study (IPS)) | Part of referenced event |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
| code |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 effective[x] |
SΣC | 1..1 | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. | |
| effective[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
 data-absent-reason |
S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
SΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation |
| Slices for value[x] |
SΣC | 0..1 | string | Actual result Slice: Unordered, Closed by type:$this |
| value[x]:valueString |
SΣC | 0..1 | string | Actual result |
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| device |
0..1 | Reference(Device - performer, observer) | (Measurement) Device | |
| hasMember |
Σ | 0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| Slices for component |
SΣ | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value |
| component:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:observationText |
SΣ | 0..* | BackboneElement | Observation Text |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |
| value[x] |
Σ | 1..1 | string | Actual component result |
| component:observationCode |
SΣ | 0..* | BackboneElement | Observation Code |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| component:numericQuantityMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present |
| component:numericRangeMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| component:numericRatioMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| component:numericSampledDataMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
Σ | 1..1 | SampledData | Actual component result |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.category:radiology | preferred | Pattern: imaginghttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | |
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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() | |
| qty-3 | error | Observation.component:numericQuantityMeasurement.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.component:numericRatioMeasurement.value[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.component:numericRangeMeasurement.value[x] | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions 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 hasMemberOrComponent: component and hasMember are mutually exclusive | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 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(Imaging Study (IPS)) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 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 |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | ||||
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] |
SΣC | 1..1 | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. | |||||
| effective[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| data-absent-reason |
S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation | ||||
| Slices for value[x] |
SΣC | 0..1 | string | Actual result Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueString |
SΣC | 0..1 | string | Actual result | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text 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, observer) | (Measurement) Device | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component |
SΣ | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value | ||||
| component:All Slices |
Content/Rules for all slices | |||||||
| 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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| 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 | |||||
| component:observationText |
SΣ | 0..* | BackboneElement | Observation Text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |||||
| value[x] |
Σ | 1..1 | string | Actual component result | ||||
| 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 | |||||
| component:observationCode |
SΣ | 0..* | BackboneElement | Observation Code | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |||||
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |||||
| 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 | |||||
| component:numericQuantityMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||
| 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 | |||||
| component:numericRangeMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||
| 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 | |||||
| component:numericRatioMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||
| 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 | |||||
| component:numericSampledDataMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
Σ | 1..1 | SampledData | Actual component result | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.category:radiology | preferred | Pattern: imaginghttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.hasMember.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | ||||
| Observation.component:observationText.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:observationText.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | ||||
| Observation.component:observationCode.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:observationCode.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericQuantityMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericQuantityMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericRangeMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericRangeMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericRatioMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericRatioMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericSampledDataMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericSampledDataMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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() | |
| qty-3 | error | Observation.component:numericQuantityMeasurement.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.component:numericRatioMeasurement.value[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.component:numericRangeMeasurement.value[x] | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) |
This structure is derived from ObservationResultsUvIps
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from ObservationResultsUvIps
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions hasMemberOrComponent: component and hasMember are mutually exclusive |
| partOf |
0..* | Reference(Imaging Study (IPS)) | Part of referenced event | |
| status |
1..1 | code | registered | preliminary | final | amended + Fixed Value: final | |
| Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this | |
| category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
| code |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| subject |
S | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about |
| effective[x] |
SC | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. |
| performer |
S | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation |
| valueString |
S | 0..1 | string | Actual result |
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| device |
0..1 | Reference(Device - performer, observer) | (Measurement) Device | |
| hasMember |
0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group | |
| reference |
0..1 | string | Literal reference, Relative, internal or absolute URL | |
| Slices for component |
S | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value |
| component:observationText |
0..* | BackboneElement | Observation Text | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |
| value[x] |
1..1 | string | Actual component result | |
| component:observationCode |
0..* | BackboneElement | Observation Code | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| component:numericQuantityMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | QuantityIPS | A measured amount using UCUM | |
| component:numericRangeMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | RangeIPS | Set of values bounded by low and high | |
| component:numericRatioMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator | |
| component:numericSampledDataMeasurement |
0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements | |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
1..1 | SampledData | Actual component result | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | |
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions 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 hasMemberOrComponent: component and hasMember are mutually exclusive |
| 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(Imaging Study (IPS)) | Part of referenced event |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
| code |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| effective[x] |
SΣC | 1..1 | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. | |
| effective[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
| data-absent-reason |
S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
SΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation |
| Slices for value[x] |
SΣC | 0..1 | string | Actual result Slice: Unordered, Closed by type:$this |
| value[x]:valueString |
SΣC | 0..1 | string | Actual result |
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| device |
0..1 | Reference(Device - performer, observer) | (Measurement) Device | |
| hasMember |
Σ | 0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| Slices for component |
SΣ | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value |
| component:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:observationText |
SΣ | 0..* | BackboneElement | Observation Text |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |
| value[x] |
Σ | 1..1 | string | Actual component result |
| component:observationCode |
SΣ | 0..* | BackboneElement | Observation Code |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
| component:numericQuantityMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present |
| component:numericRangeMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high |
| component:numericRatioMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
C | 1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| component:numericSampledDataMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |
| value[x] |
Σ | 1..1 | SampledData | Actual component result |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.category:radiology | preferred | Pattern: imaginghttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | |
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | |
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | |
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | |
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | |
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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() | |
| qty-3 | error | Observation.component:numericQuantityMeasurement.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.component:numericRatioMeasurement.value[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.component:numericRangeMeasurement.value[x] | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | ObservationResultsUvIps | Measurements and simple assertions 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 hasMemberOrComponent: component and hasMember are mutually exclusive | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| 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(Imaging Study (IPS)) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| Slices for category |
1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:radiology |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 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 |
S | 1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | ||||
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | Who and/or what the observation is about | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] |
SΣC | 1..1 | Clinically relevant time/time-period for observation ips-1: Datetime must be at least to day. | |||||
| effective[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| data-absent-reason |
S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
SΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation | ||||
| Slices for value[x] |
SΣC | 0..1 | string | Actual result Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueString |
SΣC | 0..1 | string | Actual result | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text 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, observer) | (Measurement) Device | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low |
C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high |
C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
Σ | 0..* | Reference(Observation Results: radiology (IPS) | Observation Results (IPS)) | Related resource that belongs to the Observation group | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component |
SΣ | 0..* | BackboneElement | Component results Slice: Unordered, Closed by type:value | ||||
| component:All Slices |
Content/Rules for all slices | |||||||
| 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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| 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 | |||||
| component:observationText |
SΣ | 0..* | BackboneElement | Observation Text | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Textual Observations (SNOMED-DICOM-LOINC) - IPS (extensible) | |||||
| value[x] |
Σ | 1..1 | string | Actual component result | ||||
| 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 | |||||
| component:observationCode |
SΣ | 0..* | BackboneElement | Observation Code | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | |||||
| value[x] |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |||||
| 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 | |||||
| component:numericQuantityMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume quantity measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be present | ||||
| 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 | |||||
| component:numericRangeMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume range measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | RangeIPS | Set of values bounded by low and high rng-2: If present, low SHALL have a lower value than high | ||||
| 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 | |||||
| component:numericRatioMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume ratio measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
C | 1..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present | ||||
| 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 | |||||
| component:numericSampledDataMeasurement |
SΣ | 0..* | BackboneElement | Observation Measurement, including linear, area and volume sampled data measurements | ||||
| 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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Measurement Observation (SNOMED-DICOM) - IPS (extensible): Codes identifying numeric measurements | |||||
| value[x] |
Σ | 1..1 | SampledData | Actual component result | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.category:radiology | preferred | Pattern: imaginghttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.hasMember.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:observationText.code | extensible | ResultsRadiologyTextualObservationsSnomedDicomLoincUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-txtobs-snomed-dicom-loinc-uv-ipsfrom this IG | ||||
| Observation.component:observationText.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:observationText.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:observationCode.code | extensible | ResultsRadiologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-observations-uv-ipsfrom this IG | ||||
| Observation.component:observationCode.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:observationCode.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericQuantityMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericQuantityMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericQuantityMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericRangeMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericRangeMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericRangeMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericRatioMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericRatioMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericRatioMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.component:numericSampledDataMeasurement.code | extensible | ResultsRadiologyMeasurementObservationSnomedDicomUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-radiology-numobs-snomed-dicom-uv-ipsfrom this IG | ||||
| Observation.component:numericSampledDataMeasurement.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component:numericSampledDataMeasurement.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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() | |
| qty-3 | error | Observation.component:numericQuantityMeasurement.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| rat-1 | error | Observation.component:numericRatioMeasurement.value[x] | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present : (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) | |
| rng-2 | error | Observation.component:numericRangeMeasurement.value[x] | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) |
This structure is derived from ObservationResultsUvIps
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#1.1.0 based on FHIR 4.0.1. Generated 2024-05-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change