Smart Bear Implementation Guide - Local Development build (v0.3.2). See the Directory of published versions
Resource Profile: MemberResource HearingAids Observation
| Official URL: https://smart-bear.eu/fhir/StructureDefinition/MemberResourceHAObservation | Version: 0.3.2 | |||
| Active as of 2023-11-21 | Computable Name: MemberResourceHAObservation | |||
MemberResource HearingAids Observation
Usage:
- Examples for this Resource Profile: Observation/BroadbandLevelObservation001, Observation/MainProgramObservation001, Observation/MainVolumeObservation001, Observation/MuteStatusObservation001, Observation/NoiseLevelObservation001, Observation/NoiseLevelObservation002, Observation/SignalToNoiseRationObservation001, Observation/TimeSinceBootObservation001, Observation/TotalUsageTimeObservation001
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | Measurements and simple assertions | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) |
 status | S | 1..1 | code | registered | preliminary | final | amended + |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |
| code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) |
 subject | S | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about |
| focus | S | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record |
 effective[x] | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
  effectiveDateTime | 1..1 | dateTime | Clinically relevant time/time-period for observation | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Observation.category | required | OBSVS |
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
 category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) |
| subject | SΣ | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about |
| focus | SΣ | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record |
 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.category | required | OBSVS |
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) | ||||
| subject | SΣ | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about | ||||
| focus | SΣ | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
 Slices for effective[x] | Σ | 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 | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
 value[x] | ΣC | 0..1 | Actual result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | 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..* | BackboneElement | Component results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | required | OBSVS | ||||
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Summary
Mandatory: 4 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
- Smart Bear Patient (https://smart-bear.eu/fhir/StructureDefinition/SmartBearPatient)
- Hearing Aid Device (https://smart-bear.eu/fhir/StructureDefinition/HADevice)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Observation.effective[x] is sliced based on the value of type:$this
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | Measurements and simple assertions | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) |
| status | S | 1..1 | code | registered | preliminary | final | amended + |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |
| code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) |
| subject | S | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about |
| focus | S | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record |
| effective[x] | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
| effectiveDateTime | 1..1 | dateTime | Clinically relevant time/time-period for observation | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Observation.category | required | OBSVS |
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) |
| subject | SΣ | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about |
| focus | SΣ | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record |
| 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 |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.category | required | OBSVS |
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | Observation | Measurements and simple assertions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| LocationId | S | 0..1 | CodeableConcept | Indicate the location of the device URL: https://smart-bear.eu/fhir/StructureDefinition/LocationId Binding: LocationId for Device in SmartBear project (required) | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Value Set (required) | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HearingAidProperty Value Set (required) | ||||
| subject | SΣ | 1..1 | Reference(Smart Bear Patient) | Who and/or what the observation is about | ||||
| focus | SΣ | 1..1 | Reference(Hearing Aid Device) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] | Σ | 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 | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | ΣC | 0..1 | Actual result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | 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..* | BackboneElement | Component results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | required | OBSVS | ||||
| Observation.code | required | HEAR (a valid code from HearingAidProperty Code System) | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from Observation
Summary
Mandatory: 4 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
- Smart Bear Patient (https://smart-bear.eu/fhir/StructureDefinition/SmartBearPatient)
- Hearing Aid Device (https://smart-bear.eu/fhir/StructureDefinition/HADevice)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Observation.effective[x] is sliced based on the value of type:$this
Other representations of profile: CSV, Excel, Schematron