FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

10.1.18.54 StructureDefinition: Observationbodyweight

Orders and Observations icon Work Group  Maturity Level: 4 Trial Use Use Context: Any

The canonical URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/bodyweight

FHIR Body Weight Profile

This profile was published on Sat, Aug 11, 2018 00:00+0000 as a draft by HL7 International / Orders and Observations.

10.1.18.54.1 Formal Views of Profile Content

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

This structure is derived from Observationvitalsignsbase.

Summary

10.1.18.54.2 Complete Summary of the Mandatory Requirements

  1. One code in Observation.category which must have
    • a fixed Observation.category.coding.system='http ://loinc.org'
    • a fixed Observation.category.coding.code= '29463-7'
    • The code (or codes) for the measurement obtained in Observation.code. All codes SHALL have a system value
  2. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason
    • Each Observation.valueQuantity must have:
      • One numeric value in Observation.valueQuantity.value
      • a fixed Observation.valueQuantity.system="http://unitsofmeasure.org"
      • a UCUM unit code in Observation.valueQuantity.code = 'kg', 'g', '[lb_av]' or '[oz_av]'

Must-Support: 3 elements

This indicates the differences between this profile and the base Observationvitalsignsbase structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observationvitalsignsbase FHIR Body Weight Profile
Constraints: vs-4
... code S 1..1 CodeableConcept Body Weight
Binding: Vital Signs - Body Weight (preferred): This identifies the set of LOINC codes that are appropriate for representing body weight vital sign measurements in Observation.code.
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://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 29463-7
... valueQuantity SC icon 0..1 Quantity The quantity for the vital sign being observed.
Binding: Body Weight Units (required): g | kg | [lb_av] | [oz_av]
... dataAbsentReason SC icon 0..1 CodeableConcept Why the result value is missing

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observationvitalsignsbase structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observationvitalsignsbase FHIR Body Weight Profile
Constraints: vs-4
... 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: All Languages (required): IETF language tag for a human language
Additional BindingsPurpose
Common Languages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... 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
.... observation Σ 1..1 Reference(Observation) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.
.... reason 0..1 string Reason that the observation was triggered
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: Observation Status (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: Observation Category Codes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.

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://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
...... 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
... code SΣC icon 1..1 CodeableConcept Body Weight
Binding: Vital Signs - Body Weight (preferred): This identifies the set of LOINC codes that are appropriate for representing body weight vital sign measurements in Observation.code.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 29463-7
..... 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 SΣ 1..1 Reference(Patient) 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
... organizer ΣC icon 0..1 boolean This observation organizes/groups a set of sub-observations
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
... effective[x] SΣC icon 1..1 dateTime Vital Signs are point in time measurements and are recorded using the dateTime data type
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson | HealthcareService | Group) Who is responsible for the observation
... Slices for value[x] ΣC icon 0..1 Quantity The quantity for the vital sign being observed.
Slice: Unordered, Closed by type:$this
Binding: Vital Signs Units (preferred): Commonly encountered UCUM units for recording Vital Signs.
.... value[x]:valueQuantity SΣC icon 0..1 Quantity The quantity for the vital sign being observed.
Binding: Body Weight Units (required): g | kg | [lb_av] | [oz_av]
... dataAbsentReason SC icon 0..1 CodeableConcept Why the result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
... interpretationContext 0..* CodeableReference(Resource) Context for understanding the observation
Binding: Observation Interpretation Context Codes (example): Codes identifying contextual factors that affect interpretation of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept DEPRECATED: Observed body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts
... bodyStructure 0..1 CodeableReference(BodyStructure) Observed body structure
Binding: SNOMED CT Body Structures (example): SNOMED CT Body Structures
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.
... specimen C icon 0..1 Reference(Specimen | Group) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange C icon 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 icon 0..1 Quantity Low Range, if relevant
.... high C icon 0..1 Quantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes (example): Codes identifying the normal value of the observation.
.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text C icon 0..1 markdown Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation) Used when reporting observations included in a vital signs panel
... derivedFrom Σ 0..* Reference(DocumentReference | Observation) Related resource from which the observation is made
... component ΣC icon 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 ΣC icon 1..1 CodeableConcept Vital Sign measurement or component
Binding: LOINC codes with Observation or Both (example): Codes identifying names of simple observations.
.... Slices for value[x] ΣC icon 0..1 The value for the vital sign component being observed.
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference(MolecularDefinition)
..... value[x]:valueQuantity ΣC icon 0..1 Quantity Vital Sign component value recorded as a component with UCUM (preferred)
Binding: UCUM units - for recording Vital Signs and components. icon (preferred): UCUM units - for recording Vital Signs and components.
.... dataAbsentReason C icon 0..1 CodeableConcept Why the component result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format icon
<!-- Observationbodyweight -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained   -->
 <-- category sliced by pattern:$this  in the specified orderOpen-->
 <category><!-- I 1..1 CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept Body Weight   --></code>
 <subject><!-- I 1..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- I 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <organizer value="[boolean]"/><!-- I 0..1 This observation organizes/groups a set of sub-observations -->
 <encounter><!-- I 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension --></encounter>
 <effectiveDateTime value="[dateTime]"/><!-- I 1..1 
     Vital Signs are point in time measurements and are recorded using the dateTime data type -->
 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <-- valueQuantity sliced by type:$this  in the specified orderClosed-->
 <valueQuantity><!-- I 0..1 Quantity The quantity for the vital sign being observed.   --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result value is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
 <interpretationContext><!-- I 0..* CodeableReference Context for understanding the observation   --></interpretationContext>
 <note><!-- I 0..* Annotation Comments about the observation --></note>
 <bodySite><!-- I 0..1 CodeableConcept DEPRECATED: Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 CodeableReference Observed body structure   --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) 
     A reference to the device that generates the measurements or the device settings for the device --></device>
 <referenceRange> I 0..* BackboneElement  <!-- I 0..* Provides guide for interpretation -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 0..1 Quantity 
      High Range, if relevant --></high>
  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..1 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..* CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..1 Range 
      Applicable age range, if relevant --></age>
  <text value="[markdown]"/><!-- I 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- I 0..* Reference(Observation) 
     Used when reporting observations included in a vital signs panel --></hasMember>
 <derivedFrom><!-- I 0..* Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Vital Sign measurement or component   --></code>
  <-- value[x] sliced by type:$this  in the specified orderOpen-->
  <valueQuantity><!-- I 0..1 Quantity Vital Sign component value recorded as a component with UCUM (preferred) icon   --></valueQuantity>
  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result value is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result value --></referenceRange>
 </component>
</Observation>

{ // Observationbodyweight
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
    "category" : [ //  sliced by pattern:$this  in the specified order, Open 
      { // Classification of  type of observation // I R! 
        // from Element: extension
      }
    ],
    "code" : { CodeableConcept }, // I R! Body Weight
    "subject" : { Reference(Patient) }, // I R! Who and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "organizer" : <boolean>, // IThis observation organizes/groups a set of sub-observations
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
    "effectiveDateTime" : "<dateTime>", // I R! Vital Signs are point in time measurements and are recorded using the dateTime data type
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Closed 
      { // The quantity for the vital sign being observed. // I
        // from Element: extension
      }
    ],
    "dataAbsentReason" : { CodeableConcept }, // IWhy the result value is missing
    "interpretation" : [{ CodeableConcept }], // IHigh, low, normal, etc
    "interpretationContext" : [{ CodeableReference(Resource) }], // IContext for understanding the observation
    "note" : [{ Annotation }], // IComments about the observation
    "bodySite" : { CodeableConcept }, // IDEPRECATED: Observed body part
    "bodyStructure" : { CodeableReference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // IA reference to the device that generates the measurements or the device settings for the device
    "referenceRange" : [{ BackboneElement }], // IProvides guide for interpretation
    "hasMember" : [{ Reference(Observation) }], // IUsed when reporting observations included in a vital signs panel
    "derivedFrom" : [{ Reference(DocumentReference) }], // IRelated resource from which the observation is made
    "component" : [{ BackboneElement }], // IComponent results
  }

This structure is derived from Observationvitalsignsbase.

Summary

10.1.18.54.3 Complete Summary of the Mandatory Requirements

  1. One code in Observation.category which must have
    • a fixed Observation.category.coding.system='http ://loinc.org'
    • a fixed Observation.category.coding.code= '29463-7'
    • The code (or codes) for the measurement obtained in Observation.code. All codes SHALL have a system value
  2. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason
    • Each Observation.valueQuantity must have:
      • One numeric value in Observation.valueQuantity.value
      • a fixed Observation.valueQuantity.system="http://unitsofmeasure.org"
      • a UCUM unit code in Observation.valueQuantity.code = 'kg', 'g', '[lb_av]' or '[oz_av]'

Must-Support: 3 elements

Differential View

This indicates the differences between this profile and the base Observationvitalsignsbase structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observationvitalsignsbase FHIR Body Weight Profile
Constraints: vs-4
... code S 1..1 CodeableConcept Body Weight
Binding: Vital Signs - Body Weight (preferred): This identifies the set of LOINC codes that are appropriate for representing body weight vital sign measurements in Observation.code.
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://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 29463-7
... valueQuantity SC icon 0..1 Quantity The quantity for the vital sign being observed.
Binding: Body Weight Units (required): g | kg | [lb_av] | [oz_av]
... dataAbsentReason SC icon 0..1 CodeableConcept Why the result value is missing

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observationvitalsignsbase structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Observation C icon 0..* Observationvitalsignsbase FHIR Body Weight Profile
Constraints: vs-4
... 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: All Languages (required): IETF language tag for a human language
Additional BindingsPurpose
Common Languages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... triggeredBy 0..* BackboneElement Triggering observation(s)
.... 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
.... observation Σ 1..1 Reference(Observation) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggered Bytype (required): The type of TriggeredBy Observation.
.... reason 0..1 string Reason that the observation was triggered
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
Binding: Observation Status (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: Observation Category Codes (preferred): Codes for high level observation categories.
.... category:VSCat S 1..1 CodeableConcept Classification of type of observation
Binding: Observation Category Codes (preferred): Codes for high level observation categories.

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://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: vital-signs
...... 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
... code SΣC icon 1..1 CodeableConcept Body Weight
Binding: Vital Signs - Body Weight (preferred): This identifies the set of LOINC codes that are appropriate for representing body weight vital sign measurements in Observation.code.
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://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 29463-7
..... 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 SΣ 1..1 Reference(Patient) 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
... organizer ΣC icon 0..1 boolean This observation organizes/groups a set of sub-observations
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
... effective[x] SΣC icon 1..1 dateTime Vital Signs are point in time measurements and are recorded using the dateTime data type
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson | HealthcareService | Group) Who is responsible for the observation
... Slices for value[x] ΣC icon 0..1 Quantity The quantity for the vital sign being observed.
Slice: Unordered, Closed by type:$this
Binding: Vital Signs Units (preferred): Commonly encountered UCUM units for recording Vital Signs.
.... value[x]:valueQuantity SΣC icon 0..1 Quantity The quantity for the vital sign being observed.
Binding: Body Weight Units (required): g | kg | [lb_av] | [oz_av]
... dataAbsentReason SC icon 0..1 CodeableConcept Why the result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
... interpretationContext 0..* CodeableReference(Resource) Context for understanding the observation
Binding: Observation Interpretation Context Codes (example): Codes identifying contextual factors that affect interpretation of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept DEPRECATED: Observed body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts
... bodyStructure 0..1 CodeableReference(BodyStructure) Observed body structure
Binding: SNOMED CT Body Structures (example): SNOMED CT Body Structures
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods (example): Methods for simple observations.
... specimen C icon 0..1 Reference(Specimen | Group) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) A reference to the device that generates the measurements or the device settings for the device
... referenceRange C icon 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 icon 0..1 Quantity Low Range, if relevant
.... high C icon 0..1 Quantity High Range, if relevant
.... normalValue 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes (example): Codes identifying the normal value of the observation.
.... type 0..1 CodeableConcept Reference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: Observation Reference Range Applies To Codes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text C icon 0..1 markdown Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation) Used when reporting observations included in a vital signs panel
... derivedFrom Σ 0..* Reference(DocumentReference | Observation) Related resource from which the observation is made
... component ΣC icon 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 ΣC icon 1..1 CodeableConcept Vital Sign measurement or component
Binding: LOINC codes with Observation or Both (example): Codes identifying names of simple observations.
.... Slices for value[x] ΣC icon 0..1 The value for the vital sign component being observed.
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... valueAttachment Attachment
..... valueReference Reference(MolecularDefinition)
..... value[x]:valueQuantity ΣC icon 0..1 Quantity Vital Sign component value recorded as a component with UCUM (preferred)
Binding: UCUM units - for recording Vital Signs and components. icon (preferred): UCUM units - for recording Vital Signs and components.
.... dataAbsentReason C icon 0..1 CodeableConcept Why the component result value is missing
Binding: Data Absent Reason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc
Binding: Observation Interpretation Codes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result value

doco Documentation for this format icon

XML Template

<!-- Observationbodyweight -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained   -->
 <-- category sliced by pattern:$this  in the specified orderOpen-->
 <category><!-- I 1..1 CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept Body Weight   --></code>
 <subject><!-- I 1..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- I 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <organizer value="[boolean]"/><!-- I 0..1 This observation organizes/groups a set of sub-observations -->
 <encounter><!-- I 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension --></encounter>
 <effectiveDateTime value="[dateTime]"/><!-- I 1..1 
     Vital Signs are point in time measurements and are recorded using the dateTime data type -->
 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <-- valueQuantity sliced by type:$this  in the specified orderClosed-->
 <valueQuantity><!-- I 0..1 Quantity The quantity for the vital sign being observed.   --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result value is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
 <interpretationContext><!-- I 0..* CodeableReference Context for understanding the observation   --></interpretationContext>
 <note><!-- I 0..* Annotation Comments about the observation --></note>
 <bodySite><!-- I 0..1 CodeableConcept DEPRECATED: Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 CodeableReference Observed body structure   --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) 
     A reference to the device that generates the measurements or the device settings for the device --></device>
 <referenceRange> I 0..* BackboneElement  <!-- I 0..* Provides guide for interpretation -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 0..1 Quantity 
      High Range, if relevant --></high>
  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..1 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..* CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..1 Range 
      Applicable age range, if relevant --></age>
  <text value="[markdown]"/><!-- I 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- I 0..* Reference(Observation) 
     Used when reporting observations included in a vital signs panel --></hasMember>
 <derivedFrom><!-- I 0..* Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Vital Sign measurement or component   --></code>
  <-- value[x] sliced by type:$this  in the specified orderOpen-->
  <valueQuantity><!-- I 0..1 Quantity Vital Sign component value recorded as a component with UCUM (preferred) icon   --></valueQuantity>
  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result value is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc   --></interpretation>
  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result value --></referenceRange>
 </component>
</Observation>

JSON Template

{ // Observationbodyweight
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
    "category" : [ //  sliced by pattern:$this  in the specified order, Open 
      { // Classification of  type of observation // I R! 
        // from Element: extension
      }
    ],
    "code" : { CodeableConcept }, // I R! Body Weight
    "subject" : { Reference(Patient) }, // I R! Who and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "organizer" : <boolean>, // IThis observation organizes/groups a set of sub-observations
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
    "effectiveDateTime" : "<dateTime>", // I R! Vital Signs are point in time measurements and are recorded using the dateTime data type
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Closed 
      { // The quantity for the vital sign being observed. // I
        // from Element: extension
      }
    ],
    "dataAbsentReason" : { CodeableConcept }, // IWhy the result value is missing
    "interpretation" : [{ CodeableConcept }], // IHigh, low, normal, etc
    "interpretationContext" : [{ CodeableReference(Resource) }], // IContext for understanding the observation
    "note" : [{ Annotation }], // IComments about the observation
    "bodySite" : { CodeableConcept }, // IDEPRECATED: Observed body part
    "bodyStructure" : { CodeableReference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // IA reference to the device that generates the measurements or the device settings for the device
    "referenceRange" : [{ BackboneElement }], // IProvides guide for interpretation
    "hasMember" : [{ Reference(Observation) }], // IUsed when reporting observations included in a vital signs panel
    "derivedFrom" : [{ Reference(DocumentReference) }], // IRelated resource from which the observation is made
    "component" : [{ BackboneElement }], // IComponent results
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

10.1.18.54.4 Terminology Bindings

Path Name Conformance ValueSet
Observation.language All Languages required All Languages
Observation.triggeredBy.type triggered Bytype required triggered Bytype
Observation.status Observation Status required Observation Status
Observation.category Observation Category Codes preferred Observation Category Codes
Observation.category Observation Category Codes preferred Observation Category Codes
Observation.code Vital Signs - Body Weight preferred Vital Signs - Body Weight
Observation.value[x] Body Weight Units required Body Weight Units
Observation.value[x] Body Weight Units required Body Weight Units
Observation.dataAbsentReason Data Absent Reason extensible Data Absent Reason
Observation.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
Observation.interpretationContext Observation Interpretation Context Codes example Observation Interpretation Context Codes
Observation.bodySite SNOMED CT Body Structures example SNOMED CT Body Structures
Observation.bodyStructure SNOMED CT Body Structures example SNOMED CT Body Structures
Observation.method Observation Methods example Observation Methods
Observation.referenceRange.normalValue Observation Reference Range Normal Value Codes example Observation Reference Range Normal Value Codes
Observation.referenceRange.type Observation Reference Range Meaning Codes preferred Observation Reference Range Meaning Codes
Observation.referenceRange.appliesTo Observation Reference Range Applies To Codes example Observation Reference Range Applies To Codes
Observation.component.code LOINC codes with Observation or Both example LOINC codes with Observation or Both
Observation.component.value[x] ?ext preferred http://unitsofmeasure.org/vs icon
Observation.component.dataAbsentReason Data Absent Reason extensible Data Absent Reason
Observation.component.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes

10.1.18.54.5 Constraints

Rule
Id Path Details Requirements
vs-4 Observation For single vital signs observations (that do not require use of components or hasMember), then either a value[x] or a data absent reason must be present.
Expression icon: dataAbsentReason.exists() or value.exists()
. .