ResMed Summary Observation - ResMed Core Implementation Guide v0.37.0

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 Summary Observation

Official URL: http://resmed.com/fhir/core/StructureDefinition/resmed-summary-observation				Version: 0.37.0
Draft as of 2024-01-11				Computable Name: ResMedSummaryObservation

Resource profile for ResMed summary observation containing multiple, subordinate observations summarising therapy for a specified day or defined period

Usage:

Examples for this Resource Profile: Observation/airsense-10-summary, Observation/airsense-11-summary, Observation/astral-summary and Observation/lumis-summary

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from ResMedDeviceObservation

Name	Flags	Card.	Type	Description & Constraints
Observation		0..*	ResMedDeviceObservation	Measurements and simple assertions
code		1..1	CodeableConcept	Type of observation (code / type) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: daily-summary
Slices for effective[x]		1..1	dateTime	Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this
effective[x]:effectiveDateTime		1..1	dateTime	Clinically relevant time/time-period for observation
Slices for hasMember		2..*	Reference(Observation)	Related resource that belongs to the Observation group Slice: Unordered, Open by pattern:$this.resolve().code
hasMember:periodsOfUse	S	1..1	Reference(ResMed Therapy Periods)	Related resource that belongs to the Observation group
Slices for component		1..*	BackboneElement	Component results Slice: Unordered, Open by pattern:code
component:duration	S	1..1	BackboneElement	Component results
code		1..1	CodeableConcept	Type of component observation (code / type) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-metrics-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: therapy-duration
value[x]		1..1	Quantity	Actual component result Binding: CommonUCUMCodesForDuration (required)
component:program	S	0..1	BackboneElement	Component results
code		1..1	CodeableConcept	Type of component observation (code / type) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-metrics-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: active-program
value[x]		0..1	CodeableConcept	Actual component result Binding: ResMed Therapy Program Value Set (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Observation.component:duration.value[x]	required	CommonUCUMCodesForDuration
Observation.component:program.value[x]	preferred	ResMedTherapyProgramValueSet (a valid code from ResMed Therapy Program CodeSystem)

Name	Flags	Card.	Type	Description & Constraints
Observation	C	0..*	ResMedDeviceObservation	Measurements and simple assertions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
receivedDateTime		1..1	instant	Extension URL: http://resmed.com/fhir/core/StructureDefinition/ResMedReceivedDateTime
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
code	Σ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: daily-summary
Slices for effective[x]	Σ	1..1	dateTime	Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this
effective[x]:effectiveDateTime	Σ	1..1	dateTime	Clinically relevant time/time-period for observation
issued	Σ	1..1	instant	Date/Time this version was made available
Slices for hasMember	Σ	2..*	Reference(Observation)	Related resource that belongs to the Observation group Slice: Unordered, Open by pattern:$this.resolve().code
hasMember:periodsOfUse	SΣ	1..1	Reference(ResMed Therapy Periods)	Related resource that belongs to the Observation group
Slices for component	Σ	1..*	BackboneElement	Component results Slice: Unordered, Open by pattern:code
component:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
component:duration	SΣ	1..1	BackboneElement	Component results
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-metrics-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: therapy-duration
value[x]	Σ	1..1	Quantity	Actual component result Binding: CommonUCUMCodesForDuration (required)
component:program	SΣ	0..1	BackboneElement	Component results
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-observation-metrics-code-system
code		1..1	code	Symbol in syntax defined by the system Fixed Value: active-program
value[x]	Σ	0..1	CodeableConcept	Actual component result Binding: ResMed Therapy Program Value Set (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Observation.status	required	ObservationStatus
Observation.code	example	Pattern: daily-summary
Observation.component.code	example	LOINCCodes (a valid code from LOINC)
Observation.component:duration.code	example	Pattern: therapy-duration
Observation.component:duration.value[x]	required	CommonUCUMCodesForDuration
Observation.component:program.code	example	Pattern: active-program
Observation.component:program.value[x]	preferred	ResMedTherapyProgramValueSet (a valid code from ResMed Therapy Program CodeSystem)

Constraints

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