Canadian Core
0.1.0 - CI Build

Canadian Core, published by Canadian FHIR Implementor Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/scratch-fhir-profiles/CA-Core/ and changes regularly. See the Directory of published versions

Resource Profile: Observation Profile (Laboratory Results)

Defining URL:http://hl7.org/fhir/ca/core/StructureDefinition/profile-observation-results
Version:0.1.0
Name:ObservationProfile (Laboratory Results)
Title:Observation Profile (Laboratory Results)
Status:Draft as of 2020-10-26
Definition:

Proposed constraints on the Observation Resource to represent results produced by laboratory tests or panels/studies

Publisher:Canadian FHIR Implementor Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/ca/core/StructureDefinition/profile-observation-results

CA Baseline Observation (Laboratory Results) Profile

This Observation (Laboratory Results) profile further constrains the Observation (General Use) profile to represent results of laboratory tests.

This profile may represent a single value from a specific laboratory test (e.g. hematocrit) or it may represent a grouped set of results from a multi- test study or panel (e.g. complete blood count, urinalysis, electrolytes).

The Observation (Laboratory Results) profile reflects localization concepts in the Canadian context. 

Mandatory Data Elements

All elements or attributes within the FHIR specification have cardinality as part of their definition - a minimum number of required appearances and a maximum number of allowable appearances.

Most elements in the FHIR specification have a minimum cardinality of 0, so most elements are not required and subsequently they may be missing from a resource when it is exchanged between systems.

Required elements:

  • link to the initial plan, proposal or order
  • status of the result value
  • category to classify the general type of observation being made
  • category: laboratory (mandatory child element of above)
  • code to classify what was observed
  • reference to a subject

Note: if Observation.component is provided then Observation.component.value is mandatory.

Data Absent Reason

If the minimum cardinality of an element or attribute is 1 AND information is missing AND the Responder knows the precise reason for the absence of data, then Responders SHALL send the reason for the missing information using values from the valueset where it exists by using the DataAbsentReason extension.

An Observation without a value, SHALL include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it, i.e., unless there are component observations, or references to other Observations that are grouped within it then either ONE of Observation.value OR Observation.dataAbsentReason but NOT both SHALL be present.

Must Support Data Elements

Some elements are marked as Must Support. This means that implementations generating, receiving, or otherwise using resources with Must Support elements SHALL provide support for those elements in some meaningful way (see Must Support definition).

The following elements are marked as Must Support in the Observation (Laboratory Results) profile:

Must Support elements:

  • identifier
  • category
  • category:laboratory
  • code
  • reference to a subject
  • effective date
  • value
  • dataAbsentReason
  • interpretation
  • reference range
  • hasMember
  • component.code
  • component.value[x]

Usage Note

Observation (Laboratory Results) is intended to represent results of laboratory tests and studies. This profile constrains the Observation (General Use) resource to represent laboratory results in messages and patient summaries if no other, more specific profile is more appropriate.

The following list of examples is intended to represent some examples of typical use cases and is not exhaustive:

  • complete blood count
  • prothrombin time
  • basic metabolic panel
  • comprehensive metabolic panel
  • lipid panel
  • liver panel
  • thyroid stimulating hormone
  • hemoglobin a1c
  • culture and sensitivity

including the interpretations and reference ranges associated with the result(s).

Observation (Laboratory Results) should not be used if one of the following profiles is applicable: (to be completed later)

Formal Views of Profile Content

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

This structure is derived from Observation

Summary

Mandatory: 4 elements (8 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:type
  • The element Observation.value[x] is sliced based on the value of type:$this
  • The element Observation.component.value[x] is sliced based on the value of type:$this

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationObservation Profile
... identifier S0..*IdentifierBusiness Identifier for observation
... basedOn S1..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:type
.... category:laboratory SI1..*CodeableConceptFHIR standard classification of type of observation
ca-core-category: SHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
..... coding
...... system 1..1uriFHIR standard classification of type of observation code system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1codeFHIR standard classification of type of observation code
... subject S1..1Reference(Patient Profile)Who and/or what the observation is about
... effective[x] SI0..1Clinically relevant time/time-period for observation
ca-core-datetime: Datetime SHALL be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] SI0..1(Slice Definition)Actual result
Slice: Unordered, Open by type:$this
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
.... value[x]:valueCodeableConcept I0..1CodeableConceptActual result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
..... coding 0..*CodingCode defined by a terminology system
...... system 1..1uriFHIR standard classification of type of observation code system
...... code 1..1codeA code difining laboratory result
.... value[x]:valueQuantity 0..1QuantityActual result
..... value 1..1decimalNumerical value (with implicit precision)
..... system I0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... referenceRange S0..*BackboneElementProvides guide for interpretation
... hasMember S0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... component
.... code S1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

.... value[x] SI0..1(Slice Definition)Actual component result
Slice: Unordered, Open by type:$this
ca-core-component-value: Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
..... value[x]:valueCodeableConcept I0..1CodeableConceptActual component result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
...... coding 0..*CodingFHIR standard classification of type of observation code system
....... system 1..1uriFHIR standard classification of type of observation code system
....... code 1..1codeA code defining laboratory result
..... value[x]:valueQuantity 0..1QuantityActual component result
...... value 1..1decimalNumerical value (with implicit precision)
...... system I0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
ca-core-component-value: Observation.value[x] or Observation.dataAbsentReason SHALL be present

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationObservation Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

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

... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:type
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory SI1..*CodeableConceptFHIR standard classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ca-core-category: SHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriFHIR standard classification of type of observation code system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeFHIR standard classification of type of observation code
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

... subject SΣ1..1Reference(Patient Profile)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Clinically relevant time/time-period for observation
ca-core-datetime: Datetime SHALL be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1(Slice Definition)Actual result
Slice: Unordered, Open by type:$this
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣI0..1CodeableConceptActual result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriFHIR standard classification of type of observation code system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeA code difining laboratory result
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x]:valueQuantity ΣI0..1QuantityActual result
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system ΣI0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
..... code Σ0..1codeCoded form of the unit
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

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

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


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

.... value[x] SΣI0..1(Slice Definition)Actual component result
Slice: Unordered, Open by type:$this
ca-core-component-value: Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept ΣI0..1CodeableConceptActual component result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingFHIR standard classification of type of observation code system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFHIR standard classification of type of observation code system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeA code defining laboratory result
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... value[x]:valueQuantity Σ0..1QuantityActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣI0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-component-value: Observation.value[x] or Observation.dataAbsentReason SHALL be present
.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationObservation Profile
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ1..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... category 1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:type
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory I1..*CodeableConceptFHIR standard classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ca-core-category: SHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
... subject Σ1..1Reference(Patient Profile)Who and/or what the observation is about
... effective[x] ΣI0..1Clinically relevant time/time-period for observation
ca-core-datetime: Datetime SHALL be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] ΣI0..1(Slice Definition)Actual result
Slice: Unordered, Open by type:$this
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... referenceRange I0..*BackboneElementProvides guide for interpretation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... component Σ0..*BackboneElementComponent results
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

.... value[x] ΣI0..1(Slice Definition)Actual component result
Slice: Unordered, Open by type:$this
ca-core-component-value: Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-component-value: Observation.value[x] or Observation.dataAbsentReason SHALL be present

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 4 elements (8 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:type
  • The element Observation.value[x] is sliced based on the value of type:$this
  • The element Observation.component.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationObservation Profile
... identifier S0..*IdentifierBusiness Identifier for observation
... basedOn S1..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:type
.... category:laboratory SI1..*CodeableConceptFHIR standard classification of type of observation
ca-core-category: SHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
..... coding
...... system 1..1uriFHIR standard classification of type of observation code system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1codeFHIR standard classification of type of observation code
... subject S1..1Reference(Patient Profile)Who and/or what the observation is about
... effective[x] SI0..1Clinically relevant time/time-period for observation
ca-core-datetime: Datetime SHALL be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] SI0..1(Slice Definition)Actual result
Slice: Unordered, Open by type:$this
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
.... value[x]:valueCodeableConcept I0..1CodeableConceptActual result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
..... coding 0..*CodingCode defined by a terminology system
...... system 1..1uriFHIR standard classification of type of observation code system
...... code 1..1codeA code difining laboratory result
.... value[x]:valueQuantity 0..1QuantityActual result
..... value 1..1decimalNumerical value (with implicit precision)
..... system I0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
... referenceRange S0..*BackboneElementProvides guide for interpretation
... hasMember S0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... component
.... code S1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

.... value[x] SI0..1(Slice Definition)Actual component result
Slice: Unordered, Open by type:$this
ca-core-component-value: Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
..... value[x]:valueCodeableConcept I0..1CodeableConceptActual component result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
...... coding 0..*CodingFHIR standard classification of type of observation code system
....... system 1..1uriFHIR standard classification of type of observation code system
....... code 1..1codeA code defining laboratory result
..... value[x]:valueQuantity 0..1QuantityActual component result
...... value 1..1decimalNumerical value (with implicit precision)
...... system I0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
ca-core-component-value: Observation.value[x] or Observation.dataAbsentReason SHALL be present

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationObservation Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

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

... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:type
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory SI1..*CodeableConceptFHIR standard classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ca-core-category: SHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriFHIR standard classification of type of observation code system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeFHIR standard classification of type of observation code
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

... subject SΣ1..1Reference(Patient Profile)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI0..1Clinically relevant time/time-period for observation
ca-core-datetime: Datetime SHALL be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1(Slice Definition)Actual result
Slice: Unordered, Open by type:$this
ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueCodeableConcept ΣI0..1CodeableConceptActual result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriFHIR standard classification of type of observation code system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeA code difining laboratory result
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x]:valueQuantity ΣI0..1QuantityActual result
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit representation
..... system ΣI0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
..... code Σ0..1codeCoded form of the unit
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-value: Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
... interpretation S0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

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

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


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember SΣ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (preferred): LOINC codes identifying names of simple observations.

.... value[x] SΣI0..1(Slice Definition)Actual component result
Slice: Unordered, Open by type:$this
ca-core-component-value: Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept ΣI0..1CodeableConceptActual component result
Binding: http://snomed.info/sct (preferred): A coded value SHOULD be selected from SNOMED CT.


ca-core-results-1: SHOULD use SNOMED CT for coded Results
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingFHIR standard classification of type of observation code system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriFHIR standard classification of type of observation code system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeA code defining laboratory result
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... value[x]:valueQuantity Σ0..1QuantityActual component result
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣI0..1uriSystem that defines coded unit form
ca-core-results-2: SHALL use UCUM for coded quantity units
Fixed Value: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ca-core-component-value: Observation.value[x] or Observation.dataAbsentReason SHALL be present
.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:laboratorypreferredObservationCategoryCodes
Observation.codepreferredLOINCCodes
Observation.value[x]:valueCodeableConceptpreferredhttp://snomed.info/sct
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codepreferredLOINCCodes
Observation.component.value[x]:valueCodeableConceptpreferredhttp://snomed.info/sct
Observation.component.value[x]:valueQuantity.comparatorrequiredQuantityComparator
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationIf 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-4ObservationIf 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-5ObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7ObservationIf 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()
ele-1Observation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-categoryObservation.category:laboratorySHALL have a category from 'http://terminology.hl7.org/CodeSystem/observation-category'
: where(coding.system='http://terminology.hl7.org/CodeSystem/observation-category' and coding.code.exists()).exists()
ele-1Observation.category:laboratory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.category:laboratory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.category:laboratory.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.category:laboratory.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.category:laboratory.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:laboratory.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-datetimeObservation.effective[x]Datetime SHALL be at least to day
: ($this as dateTime).toString().length() >= 8
ele-1Observation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-valueObservation.value[x]Observation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
: value[x].exists() or dataAbsentReason.exists() or component.exists()
ele-1Observation.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-results-1Observation.value[x]:valueCodeableConceptSHOULD use SNOMED CT for coded Results
: valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct'
ele-1Observation.value[x]:valueCodeableConcept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.value[x]:valueCodeableConcept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.value[x]:valueCodeableConcept.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.value[x]:valueCodeableConcept.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.value[x]:valueCodeableConcept.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueCodeableConcept.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.value[x]:valueQuantity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.value[x]:valueQuantity.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]:valueQuantity.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-results-2Observation.value[x]:valueQuantity.systemSHALL use UCUM for coded quantity units
: where(valueQuantity.system='http://unitsofmeasure.org' and valueQuantity.value.exists()).exists()
ele-1Observation.value[x]:valueQuantity.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-valueObservation.dataAbsentReasonObservation.value[x] or Observation.dataAbsentReason or Observation.component SHOULD be present
: value[x].exists() or dataAbsentReason.exists() or component.exists()
ele-1Observation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1Observation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-component-valueObservation.component.value[x]Observation.component.value[x] or Observation.component.dataAbsentReason SHALL be present
: component.value[x].exists() or component.dataAbsentReason.exists()
ele-1Observation.component.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-results-1Observation.component.value[x]:valueCodeableConceptSHOULD use SNOMED CT for coded Results
: valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct'
ele-1Observation.component.value[x]:valueCodeableConcept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.value[x]:valueCodeableConcept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.value[x]:valueCodeableConcept.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.value[x]:valueCodeableConcept.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.value[x]:valueCodeableConcept.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueCodeableConcept.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueQuantity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.value[x]:valueQuantity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.value[x]:valueQuantity.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueQuantity.comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueQuantity.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]:valueQuantity.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-results-2Observation.component.value[x]:valueQuantity.systemSHALL use UCUM for coded quantity units
: where(valueQuantity.system='http://unitsofmeasure.org' and valueQuantity.value.exists()).exists()
ele-1Observation.component.value[x]:valueQuantity.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ca-core-component-valueObservation.component.dataAbsentReasonObservation.value[x] or Observation.dataAbsentReason SHALL be present
: value[x].exists() or dataAbsentReason.exists()
ele-1Observation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Notes:

Using codes in Observation

Additional codes that translate or map to the Observation code or category codes are allowed (see CodeableConcept data type). For example: providing both a local code and LOINC code providing a more specific category codes, SNOMED CT concept, or system specific codes.

Category

The Observation.category specifies a code that classifies the general type of observation being made. The Observation.category element is CodeableConcept data type and more than one code is allowed. For interoperability reason one of the codes SHOULD be from the FHIR standard defined Observation Category Codes. Local codes are allowed as well. In case of using local codes to better classify the type both category.coding.system and category.coding.code SHOULD be provided.

Code

The Observation.code element describes what was observed. Sometimes this is called the observation “name”.

The pan-Canadian LOINC Observation Code Database (pCLOCD) is recommended for use in a Canadian context. Code System URI is https://fhir.infoway-inforoute.ca/CodeSystem/pCLOCD

value[x]

If the result value is a code:

  • both valueCodeableConcept.coding.system and valueCodeableConcept.coding.code SHALL be present
  • a code from SNOMED CT SHOULD be used
  • additional codes that translate or map Observation code or category codes are allowed

If the result value is a numeric quantity:

  • valueQuantity.value , valueQuantity.unit and valueQuantity.sytem SHALL be present
  • a standard UCUM unit SHALL be used.

dataAbsentReason

An Observation without a value SHALL include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it. I.e., if Observation.value[x] is missed, the Observation.dataAbsentReason SHALL be present and provide a reason why the expected value is missing. Also, the Observation.dataAbsentReason SHALL only be present if Observation.value[x] is not present