Smart Bear Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
Resource Profile: Weight Loss Observation
| Defining URL: | https://140.164.14.210/fhir/StructureDefinition/WeightLossObservation |
| Version: | 1.0.0 |
| Name: | WeightLossObservation |
| Title: | Weight Loss Observation |
| Status: | Active as of 2021-06-09T14:27:31+02:00 |
| Definition: | Observation of the weight loss |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://140.164.14.210/fhir/StructureDefinition/WeightLossObservation
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
Mandatory: 1 element
Slices
This structure defines the following Slices:
- The element Observation.value[x] is sliced based on the value of type:$this
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | 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://snomed.info/sct | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 107647005 | |
| subject | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | |
 value[x] | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 0..1 | CodeableConcept | Actual result 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://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 89362005 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Weight Loss | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Observation | Measurements and simple assertions |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
 basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 107647005 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | Location) | 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..1 | Reference(Encounter) | Healthcare event during which this observation is made |
 effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| 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] | ΣI | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Closed by type:$this |
  value[x]:valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result Required Pattern: At least the following |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 89362005 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Weight Loss | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
 text | 0..1 | string | Plain text representation of the concept | |
| dataAbsentReason | I | 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 | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| 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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 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 | I | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Observation | Measurements and simple assertions |
| Documentation for this format | ||||
This structure is derived from Observation
Summary
Mandatory: 1 element
Slices
This structure defines the following Slices:
- The element Observation.value[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 | |
| 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://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 107647005 | |
| subject | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | |
| value[x] | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 0..1 | CodeableConcept | Actual result 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://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 89362005 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Weight Loss | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Observation | Measurements and simple assertions |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 107647005 | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | Location) | 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..1 | Reference(Encounter) | Healthcare event during which this observation is made |
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| 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] | ΣI | 0..1 | (Slice Definition) | Actual result Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 89362005 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Weight Loss | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| dataAbsentReason | I | 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 | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| 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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 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 | I | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Observation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.code | example | Pattern: SNOMED CT code 107647005 |
| 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 |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Constraints
| Id | Path | Details | Requirements |
| obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |