ResMed Core Implementation Guide
0.37.0 - ci-build International flag

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

Resource Profile: ResMed Rule Outcome Observation

Official URL: http://resmed.com/fhir/core/StructureDefinition/observation-rmd-rule-outcome Version: 0.37.0
Draft as of 2024-01-11 Computable Name: ObservationRmdRuleOutcome

The base profile for all rules engine outcomes as an Observation.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... basedOn S0..*Reference(ResMed Rule Instance ServiceRequest)Fulfills plan, proposal or order. For ResMed rule outcomes, this should reference the ServiceRequest connecting the patient with the rule.
... status S1..1coderegistered | preliminary | final | amended +
.... category:outcome 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
.... category:therapy 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
... code S1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject S1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... effective[x] S1..1dateTimeDateTime of analysed sleep
... issued S1..1instantDateTime outcome scored
... value[x] 0..0
... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... device S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... derivedFrom 0..*Reference(Observation)The Observations used in determining this outcome
... component 0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... code S1..1CodeableConceptType of component observation (code / type)
Binding: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] S0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ResMed Observation Categories Value Set (required)
.... category:outcome 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
.... category:therapy 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
... code SΣ1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject SΣ1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... effective[x] SΣ1..1dateTimeDateTime of analysed sleep
... issued SΣ1..1instantDateTime outcome scored
... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... device S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... derivedFrom Σ0..*Reference(Observation)The Observations used in determining this outcome
... component Σ0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] SΣ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.category:outcomepreferredPattern: rule-outcome
Observation.category:therapypreferredPattern: therapy
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn SΣ0..*Reference(ResMed Rule Instance ServiceRequest)Fulfills plan, proposal or order. For ResMed rule outcomes, this should reference the ServiceRequest connecting the patient with the rule.
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ResMed Observation Categories Value Set (required)
.... category:outcome 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:therapy 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject SΣ1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... 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Σ1..1dateTimeDateTime of analysed sleep
... issued SΣ1..1instantDateTime outcome scored
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... 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 S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... referenceRange C0..*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 C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(Observation)The Observations used in determining this outcome
... component Σ0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... 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: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] SΣ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.category:outcomepreferredPattern: rule-outcome
Observation.category:therapypreferredPattern: therapy
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

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

This structure is derived from Observation

Summary

Mandatory: 6 elements
Must-Support: 10 elements
Prohibited: 1 element

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:$this

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... basedOn S0..*Reference(ResMed Rule Instance ServiceRequest)Fulfills plan, proposal or order. For ResMed rule outcomes, this should reference the ServiceRequest connecting the patient with the rule.
... status S1..1coderegistered | preliminary | final | amended +
.... category:outcome 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
.... category:therapy 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
... code S1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject S1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... effective[x] S1..1dateTimeDateTime of analysed sleep
... issued S1..1instantDateTime outcome scored
... value[x] 0..0
... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... device S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... derivedFrom 0..*Reference(Observation)The Observations used in determining this outcome
... component 0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... code S1..1CodeableConceptType of component observation (code / type)
Binding: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] S0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ResMed Observation Categories Value Set (required)
.... category:outcome 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
.... category:therapy 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
... code SΣ1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject SΣ1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... effective[x] SΣ1..1dateTimeDateTime of analysed sleep
... issued SΣ1..1instantDateTime outcome scored
... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... device S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... derivedFrom Σ0..*Reference(Observation)The Observations used in determining this outcome
... component Σ0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] SΣ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.category:outcomepreferredPattern: rule-outcome
Observation.category:therapypreferredPattern: therapy
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeA human-readable summary describing the reason the rule outcome was captured.
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn SΣ0..*Reference(ResMed Rule Instance ServiceRequest)Fulfills plan, proposal or order. For ResMed rule outcomes, this should reference the ServiceRequest connecting the patient with the rule.
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ResMed Observation Categories Value Set (required)
.... category:outcome 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-category-code-system
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: rule-outcome
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:therapy 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: therapy
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptA code identifying the clinical or compliance outcome type, e.g. patient-compliance-progress
Binding: ResMed All Rule Outcome Types Value Set (extensible)
... subject SΣ1..1Reference(ResMed Patient)The patient who is the subject of the outcome
... 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Σ1..1dateTimeDateTime of analysed sleep
... issued SΣ1..1instantDateTime outcome scored
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation S0..*CodeableConceptWhether this outcome is normal, compliant, low, etc.
Binding: ResMed Rule Outcome Interpretation Value Set (required)
... 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 S1..1Reference(ResMed Rules Engine Software Profile)(Measurement) Device
... referenceRange C0..*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 C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(Observation)The Observations used in determining this outcome
... component Σ0..*BackboneElementEach component represents a key-value pair in the originating outcome. Keys are expressed as codes.
.... 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: ResMed Rule Outcome Components Value Set (extensible)
.... value[x] SΣ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categoryrequiredValueSetResMedObservationCategoryCodes
Observation.category:outcomepreferredPattern: rule-outcome
Observation.category:therapypreferredPattern: therapy
Observation.codeextensibleValueSetResMedAllRuleOutcomeTypeCodes
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationrequiredValueSetResMedRuleOutcomeInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeextensibleValueSetResMedRuleOutcomeComponentCodes (a valid code from ResMed Rule Outcome Components Code System)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

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

This structure is derived from Observation

Summary

Mandatory: 6 elements
Must-Support: 10 elements
Prohibited: 1 element

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:$this

 

Other representations of profile: CSV, Excel, Schematron