International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
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 2.0.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-laboratory-pathology-uv-ips | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: ObservationResultsLaboratoryPathologyUvIps | ||
This profile constrains the Observation resource to represent results produced by laboratory (including pathology) tests or panels/studies in a patient summary.
This observation may represent the result of a simple laboratory test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and or a global interpretation by the producer of the study, in the comment element; and references the atomic results of the study as "has-member" child observations.
This profile constrains the Observation resource to represent a laboratory or pathology in vitro diagnostic test or panel/study. In case of a panel or multiple-observation study, the results of the panel or study appear as sub-observations. In this case this top-level Observation acts as a grouper of all the observations belonging to the panel or study. The top-level observation may carry a conclusion in the value element and or a global interpretation by the producer of the study, in the comment element.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: obs-6, obs-7, ips-2, ips-3 | |||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||||
  Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||
   category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
| |||||||||||
  id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | ||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||
| version |
0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||
 text |
0..1 | string | Plain text representation of the concept | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| |||||||||||
 subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| |||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| ||||||||||||
 effectiveDateTime |
dateTime | ||||||||||||||
| effectivePeriod |
Period | ||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation
| |||||||||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||
 extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| |||||||||||
| performer |
SOΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| |||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | ||||||||||||
| valueQuantity |
Quantity | ||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||
| valueString |
string | ||||||||||||||
| valueBoolean |
boolean | ||||||||||||||
| valueInteger |
integer | ||||||||||||||
| valueRange |
Range | ||||||||||||||
| valueRatio |
Ratio | ||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||
| valueTime |
time | ||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||
| valuePeriod |
Period | ||||||||||||||
| value[x]:valueString |
SOΣC | 0..1 | string | Actual result
| |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| |||||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | ||||||||||||
| hasMember |
Σ | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||||
 component |
SOΣ | 0..* | BackboneElement | Component results
| |||||||||||
| 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. | |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:laboratory | preferred | Pattern Value: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom 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() | |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.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() |
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: ips-2, ips-3 | ||||||||
 status |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||
| Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this | |||||||||
| category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following
| ||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| code |
SO | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| ||||||||
| subject |
SO | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Slices for effective[x] |
SO | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| |||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectiveDateTime |
SO | 0..1 | dateTime | Clinically relevant time/time-period for observation
| ||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| performer |
SO | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |||||||||
| value[x]:valueString |
SO | 0..1 | string | Actual result
| ||||||||
| value[x]:valueQuantity |
SO | 0..1 | Quantity | Actual result
| ||||||||
| value[x]:valueCodeableConcept |
SO | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. | |||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | |||||||||
| hasMember |
0..* | Reference(Observation Results - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||
| component |
SO | 0..* | BackboneElement | Component results
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | |
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.exists()) |
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: obs-6, obs-7, ips-2, ips-3 | |||||||||||
| 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(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||||
| Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||
| category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||
| version |
0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||
| text |
0..1 | string | Plain text representation of the concept | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| |||||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||
| reference |
SOΣ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 | |||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| ||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||
| effectivePeriod |
Period | ||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation
| |||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||
| extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| |||||||||||
| value |
0..1 | dateTime | Primitive value for dateTime | ||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||
| performer |
SOΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| |||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | ||||||||||||
| valueQuantity |
Quantity | ||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||
| valueString |
string | ||||||||||||||
| valueBoolean |
boolean | ||||||||||||||
| valueInteger |
integer | ||||||||||||||
| valueRange |
Range | ||||||||||||||
| valueRatio |
Ratio | ||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||
| valueTime |
time | ||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||
| valuePeriod |
Period | ||||||||||||||
| value[x]:valueString |
SOΣC | 0..1 | string | Actual result
| |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| |||||||||||
| 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..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | ||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| low |
C | 0..1 | SimpleQuantity | 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 - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||||||
| component |
SOΣ | 0..* | BackboneElement | Component results
| |||||||||||
| 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 | ||||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:laboratory | preferred | Pattern Value: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG | ||||
| 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.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 |
| 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() | |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.exists()) | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
Summary
Mandatory: 6 elements
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: obs-6, obs-7, ips-2, ips-3 | |||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||||
| Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||
| category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||
| version |
0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||
| text |
0..1 | string | Plain text representation of the concept | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| |||||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| |||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| ||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||
| effectivePeriod |
Period | ||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation
| |||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||
| extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| |||||||||||
| performer |
SOΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| |||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | ||||||||||||
| valueQuantity |
Quantity | ||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||
| valueString |
string | ||||||||||||||
| valueBoolean |
boolean | ||||||||||||||
| valueInteger |
integer | ||||||||||||||
| valueRange |
Range | ||||||||||||||
| valueRatio |
Ratio | ||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||
| valueTime |
time | ||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||
| valuePeriod |
Period | ||||||||||||||
| value[x]:valueString |
SOΣC | 0..1 | string | Actual result
| |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| |||||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | ||||||||||||
| hasMember |
Σ | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||||
| component |
SOΣ | 0..* | BackboneElement | Component results
| |||||||||||
| 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. | |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | |
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.category:laboratory | preferred | Pattern Value: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | |
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG | |
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom 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() | |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.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() |
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: ips-2, ips-3 | ||||||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||
| Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this | |||||||||
| category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following
| ||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||||||
| code |
SO | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| ||||||||
| subject |
SO | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Slices for effective[x] |
SO | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| |||||||||
| effectiveDateTime |
dateTime | |||||||||||
| effectivePeriod |
Period | |||||||||||
| effective[x]:effectiveDateTime |
SO | 0..1 | dateTime | Clinically relevant time/time-period for observation
| ||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| ||||||||
| performer |
SO | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| ||||||||
| Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result Slice: Unordered, Open by type:$this | |||||||||
| value[x]:valueString |
SO | 0..1 | string | Actual result
| ||||||||
| value[x]:valueQuantity |
SO | 0..1 | Quantity | Actual result
| ||||||||
| value[x]:valueCodeableConcept |
SO | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| ||||||||
| interpretation |
0..* | CodeableConceptIPS | High, low, normal, etc. | |||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | |||||||||
| hasMember |
0..* | Reference(Observation Results - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||
| component |
SO | 0..* | BackboneElement | Component results
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | |
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | |
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Laboratory (including Pathology) result for a simple test or for a panel/study Constraints: obs-6, obs-7, ips-2, ips-3 | |||||||||||
| 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(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||||||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Results Status Codes - IPS (required) | |||||||||||
| Slices for category |
1..* | CodeableConceptIPS | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||||||||||
| category:laboratory |
SO | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||||||||||
| version |
0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | ||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||
| text |
0..1 | string | Plain text representation of the concept | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Type of observation (code / type) Binding: Results Laboratory/Pathology Observation - IPS (preferred)
| |||||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group | Device | Location) | Who and/or what the observation is about
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||
| reference |
SOΣ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 | |||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
| ||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||
| effectivePeriod |
Period | ||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for observation
| |||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||
| extension:data-absent-reason |
SO | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
| |||||||||||
| value |
0..1 | dateTime | Primitive value for dateTime | ||||||||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | |||||||||||
| performer |
SOΣ | 1..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam | Patient (IPS) | RelatedPerson) | Who is responsible for the observation
| |||||||||||
| Slices for value[x] |
ΣC | 0..1 | Actual result Slice: Unordered, Open by type:$this | ||||||||||||
| valueQuantity |
Quantity | ||||||||||||||
| valueCodeableConcept |
CodeableConcept | ||||||||||||||
| valueString |
string | ||||||||||||||
| valueBoolean |
boolean | ||||||||||||||
| valueInteger |
integer | ||||||||||||||
| valueRange |
Range | ||||||||||||||
| valueRatio |
Ratio | ||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||
| valueTime |
time | ||||||||||||||
| valueDateTime |
dateTime | ||||||||||||||
| valuePeriod |
Period | ||||||||||||||
| value[x]:valueString |
SOΣC | 0..1 | string | Actual result
| |||||||||||
| value[x]:valueQuantity |
SOΣC | 0..1 | Quantity | Actual result
| |||||||||||
| value[x]:valueCodeableConcept |
SOΣC | 0..1 | CodeableConceptIPS | Actual result Binding: Results Coded Values Laboratory/Pathology - IPS (preferred)
| |||||||||||
| 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..* | CodeableConceptIPS | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||||||||||
| note |
0..* | Annotation | Comments about the observation | ||||||||||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||||||||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | ||||||||||||
| specimen |
0..1 | Reference(Specimen (IPS)) | Specimen used for this observation | ||||||||||||
| device |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | ||||||||||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| low |
C | 0..1 | SimpleQuantity | 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 - Laboratory/Pathology (IPS)) | Related resource that belongs to the Observation group | |||||||||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||||||||
| component |
SOΣ | 0..* | BackboneElement | Component results
| |||||||||||
| 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 | ||||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Observation.status | required | ResultsStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-status-uv-ipsFrom this IG | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.category:laboratory | preferred | Pattern Value: laboratoryhttp://hl7.org/fhir/ValueSet/observation-categoryFrom the FHIR Standard | ||||
| Observation.code | preferred | ResultsLaboratoryPathologyObservationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-pathology-observations-uv-ipsFrom this IG | ||||
| Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Observation.value[x]:valueCodeableConcept | preferred | ResultsCodedValuesLaboratoryPathologyUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-pathology-uv-ipsFrom this IG | ||||
| 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.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 |
| 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() | |
| ips-2 | error | Observation | At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" : value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists() | |
| ips-3 | error | Observation | If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" : component.exists() implies (component.value.exists() or component.dataAbsentReason.exists()) | |
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
Summary
Mandatory: 6 elements
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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#2.0.0 based on FHIR 4.0.1. Generated 2025-06-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change