StructureDefinition: BodyWeight - FHIR v3.4.0
Current Build
Orders and Observations Work Group Maturity Level: 1Trial Use Use Context: Any

The official 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 Health Level Seven International (Orders and Observations Workgroup).

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

This structure is derived from Vital Signs Profile.

Summary

  1. One code in Observation.code which must have
    • a fixed Observation.code.coding.system='http ://loinc.org'
    • a fixed Observation.code.coding.code= '29463-7'
    • Other additional Codings are allowed in Observation.code- e.g. more specific LOINC Codes, SNOMED CT concepts, system specific codes. All codes SHALL have an 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', or '[lb_av]'

Mandatory: 3 elements (+4 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the values of value:code, value:system

This structure is derived from Vital Signs Profile.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*FHIR Body Weight Profile
... code 1..1CodeableConceptBody Weight
.... coding CodingSlice: Unordered, Open by value:code, value:system
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://loinc.org
..... code 1..1codeFixed Value: 29463-7
... valueQuantity 0..1Quantity
.... value S1..1decimal
.... unit S1..1string
.... system S1..1uriFixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded responses from the common UCUM units for vital signs value set.
Binding: Body Weight Units (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FHIR Body Weight Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SCodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: Observation Category Codes (preferred)
... category S1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptBody Weight
Binding: Vital Signs (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code, value:system
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 29463-7
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(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
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1dateTime, PeriodOften just a dateTime for Vital Signs
vs-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
.... id 0..1stringxml:id (or equivalent in JSON)
.... value SΣ1..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit SΣ1..1stringUnit representation
.... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code SΣ1..1codeCoded responses from the common UCUM units for vital signs value set.
Binding: Body Weight Units (required)
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about the test result value
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(QuestionnaireResponse | Sequence | VitalSigns)Used when reporting vital signs panel components
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Sequence | VitalSigns)Related measurements the observation is made from
... component SΣI0..*BackboneElementUsed when reporting systolic and diastolic blood pressure.
vs-3: If there is no a value a data absent reason must be present
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: Vital Signs (extensible)
.... value[x] SΣ0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodVital Sign Value recorded with UCUM
Binding: Vital Signs Units (required)
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format
<!-- observation-bodyweight -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended +   -->
 <-- category sliced by value:coding.code, value:coding.system  in the specified orderOpen-->
 <category> 1..1 CodeableConcept  <!-- 1..1 Classification of  type of observation -->
  <coding> 1..* Coding  <!-- 1..* Code defined by a terminology system -->
   <system value="[uri]"/><!-- 1..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 1..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </category>
 <code> 1..1 CodeableConcept  <!-- 1..1 Body Weight -->
  <-- coding sliced by value:code, value:system  in the specified orderOpen-->
  <coding> 1..1 Coding  <!-- 1..1 Code defined by a terminology system -->
   <system value="[uri]"/><!-- 1..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 1..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </code>
 <subject><!-- 1..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <encounter><!-- 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></encounter>
 <effective[x]><!-- ?? 1..1 dateTime|Period 
     Often just a dateTime for Vital Signs --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available -->
 <performer><!-- 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <valueQuantity> 0..1 Quantity  <!-- 0..1 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. -->
  <value value="[decimal]"/><!-- 1..1 Numerical value (with implicit precision) -->
  <comparator value="[code]"/><!-- 0..1 < | <= | >= | > - how to understand the value   -->
  <unit value="[string]"/><!-- 1..1 Unit representation -->
  <system value="[uri]"/><!-- 1..1 System that defines coded unit form -->
  <code value="[code]"/><!-- 1..1 Coded responses from the common UCUM units for vital signs value set.   -->
 </valueQuantity>
 <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- 0..* CodeableConcept High, low, normal, etc.   --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about the test result value -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part   --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> ?? 0..* BackboneElement  <!-- ?? 0..* Provides guide for interpretation -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored if unrecognized  --></modifierExtension>
  <low><!-- 0..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- 0..1 Quantity 
      High Range, if relevant --></high>
  <type><!-- 0..1 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- 0..* CodeableConcept Reference range population   --></appliesTo>
  <age><!-- 0..1 Range 
      Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- 0..* Reference(QuestionnaireResponse) 
     Used when reporting vital signs panel components --></hasMember>
 <derivedFrom><!-- 0..* Reference(DocumentReference) 
     Related measurements the observation is made from --></derivedFrom>
 <component> ?? 0..* BackboneElement  <!-- ?? 0..* Used when reporting systolic and diastolic blood pressure. -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored if unrecognized  --></modifierExtension>
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Vital Sign Value recorded with UCUM   --></value[x]>
  <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- 0..* CodeableConcept High, low, normal, etc.   --></interpretation>
  <referenceRange><!-- See #Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>
{ // observation-bodyweight
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order
    "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event
    "status" : "<code>", // R! registered | preliminary | final | amended +
    "category" : [ //  sliced by value:coding.code, value:coding.system  in the specified order, Open 
      { // Classification of  type of observation // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "coding" : [{ Coding }], // R! Code defined by a terminology system
        "text" : "<string>" //Plain text representation of the concept
      }
    ],
    "code" : { CodeableConcept }, // R! Body Weight
    "subject" : { Reference(Patient) }, // R! Who and/or what the observation is about
    "focus" : [{ Reference(Resource) }], //What the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, //Healthcare event during which this observation is made
// value[x]: Often just a dateTime for Vital Signs. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C? R! Often just a dateTime for Vital Signs
    "effectivePeriod" : { Period }, // C? R! Often just a dateTime for Vital Signs
    "issued" : "<instant>", //Date/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation
    "valueQuantity" : { Quantity }, //Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
    "dataAbsentReason" : { CodeableConcept }, //Why the result is missing
    "interpretation" : [{ CodeableConcept }], //High, low, normal, etc.
    "comment" : "<string>", //Comments about the test result value
    "bodySite" : { CodeableConcept }, //Observed body part
    "method" : { CodeableConcept }, //How it was done
    "specimen" : { Reference(Specimen) }, //Specimen used for this observation
    "device" : { Reference(Device) }, //(Measurement) Device
    "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation
    "hasMember" : [{ Reference(QuestionnaireResponse) }], //Used when reporting vital signs panel components
    "derivedFrom" : [{ Reference(DocumentReference) }], //Related measurements the observation is made from
    "component" : [{ BackboneElement }] // C?Used when reporting systolic and diastolic blood pressure.
  }

This structure is derived from Vital Signs Profile.

Summary

  1. One code in Observation.code which must have
    • a fixed Observation.code.coding.system='http ://loinc.org'
    • a fixed Observation.code.coding.code= '29463-7'
    • Other additional Codings are allowed in Observation.code- e.g. more specific LOINC Codes, SNOMED CT concepts, system specific codes. All codes SHALL have an 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', or '[lb_av]'

Mandatory: 3 elements (+4 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the values of value:code, value:system

Differential View

This structure is derived from Vital Signs Profile.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*FHIR Body Weight Profile
... code 1..1CodeableConceptBody Weight
.... coding CodingSlice: Unordered, Open by value:code, value:system
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://loinc.org
..... code 1..1codeFixed Value: 29463-7
... valueQuantity 0..1Quantity
.... value S1..1decimal
.... unit S1..1string
.... system S1..1uriFixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded responses from the common UCUM units for vital signs value set.
Binding: Body Weight Units (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FHIR Body Weight Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SCodeableConceptClassification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: Observation Category Codes (preferred)
... category S1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: vital-signs
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptBody Weight
Binding: Vital Signs (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code, value:system
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 29463-7
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(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
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1dateTime, PeriodOften just a dateTime for Vital Signs
vs-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1QuantityVital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
.... id 0..1stringxml:id (or equivalent in JSON)
.... value SΣ1..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit SΣ1..1stringUnit representation
.... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code SΣ1..1codeCoded responses from the common UCUM units for vital signs value set.
Binding: Body Weight Units (required)
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about the test result value
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (preferred)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(QuestionnaireResponse | Sequence | VitalSigns)Used when reporting vital signs panel components
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Sequence | VitalSigns)Related measurements the observation is made from
... component SΣI0..*BackboneElementUsed when reporting systolic and diastolic blood pressure.
vs-3: If there is no a value a data absent reason must be present
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... code SΣ1..1CodeableConceptType of component observation (code / type)
Binding: Vital Signs (extensible)
.... value[x] SΣ0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodVital Sign Value recorded with UCUM
Binding: Vital Signs Units (required)
.... dataAbsentReason SI0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

<!-- observation-bodyweight -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended +   -->
 <-- category sliced by value:coding.code, value:coding.system  in the specified orderOpen-->
 <category> 1..1 CodeableConcept  <!-- 1..1 Classification of  type of observation -->
  <coding> 1..* Coding  <!-- 1..* Code defined by a terminology system -->
   <system value="[uri]"/><!-- 1..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 1..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </category>
 <code> 1..1 CodeableConcept  <!-- 1..1 Body Weight -->
  <-- coding sliced by value:code, value:system  in the specified orderOpen-->
  <coding> 1..1 Coding  <!-- 1..1 Code defined by a terminology system -->
   <system value="[uri]"/><!-- 1..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 1..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </code>
 <subject><!-- 1..1 Reference(Patient) 
     Who and/or what the observation is about --></subject>
 <focus><!-- 0..* Reference(Resource) 
     What the observation is about, when it is not about the subject of record --></focus>
 <encounter><!-- 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></encounter>
 <effective[x]><!-- ?? 1..1 dateTime|Period 
     Often just a dateTime for Vital Signs --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available -->
 <performer><!-- 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <valueQuantity> 0..1 Quantity  <!-- 0..1 Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. -->
  <value value="[decimal]"/><!-- 1..1 Numerical value (with implicit precision) -->
  <comparator value="[code]"/><!-- 0..1 < | <= | >= | > - how to understand the value   -->
  <unit value="[string]"/><!-- 1..1 Unit representation -->
  <system value="[uri]"/><!-- 1..1 System that defines coded unit form -->
  <code value="[code]"/><!-- 1..1 Coded responses from the common UCUM units for vital signs value set.   -->
 </valueQuantity>
 <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- 0..* CodeableConcept High, low, normal, etc.   --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about the test result value -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part   --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> ?? 0..* BackboneElement  <!-- ?? 0..* Provides guide for interpretation -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored if unrecognized  --></modifierExtension>
  <low><!-- 0..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- 0..1 Quantity 
      High Range, if relevant --></high>
  <type><!-- 0..1 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- 0..* CodeableConcept Reference range population   --></appliesTo>
  <age><!-- 0..1 Range 
      Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- 0..* Reference(QuestionnaireResponse) 
     Used when reporting vital signs panel components --></hasMember>
 <derivedFrom><!-- 0..* Reference(DocumentReference) 
     Related measurements the observation is made from --></derivedFrom>
 <component> ?? 0..* BackboneElement  <!-- ?? 0..* Used when reporting systolic and diastolic blood pressure. -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored if unrecognized  --></modifierExtension>
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period Vital Sign Value recorded with UCUM   --></value[x]>
  <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- 0..* CodeableConcept High, low, normal, etc.   --></interpretation>
  <referenceRange><!-- See #Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template

{ // observation-bodyweight
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order
    "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event
    "status" : "<code>", // R! registered | preliminary | final | amended +
    "category" : [ //  sliced by value:coding.code, value:coding.system  in the specified order, Open 
      { // Classification of  type of observation // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "coding" : [{ Coding }], // R! Code defined by a terminology system
        "text" : "<string>" //Plain text representation of the concept
      }
    ],
    "code" : { CodeableConcept }, // R! Body Weight
    "subject" : { Reference(Patient) }, // R! Who and/or what the observation is about
    "focus" : [{ Reference(Resource) }], //What the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, //Healthcare event during which this observation is made
// value[x]: Often just a dateTime for Vital Signs. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C? R! Often just a dateTime for Vital Signs
    "effectivePeriod" : { Period }, // C? R! Often just a dateTime for Vital Signs
    "issued" : "<instant>", //Date/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation
    "valueQuantity" : { Quantity }, //Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
    "dataAbsentReason" : { CodeableConcept }, //Why the result is missing
    "interpretation" : [{ CodeableConcept }], //High, low, normal, etc.
    "comment" : "<string>", //Comments about the test result value
    "bodySite" : { CodeableConcept }, //Observed body part
    "method" : { CodeableConcept }, //How it was done
    "specimen" : { Reference(Specimen) }, //Specimen used for this observation
    "device" : { Reference(Device) }, //(Measurement) Device
    "referenceRange" : [{ BackboneElement }], // C?Provides guide for interpretation
    "hasMember" : [{ Reference(QuestionnaireResponse) }], //Used when reporting vital signs panel components
    "derivedFrom" : [{ Reference(DocumentReference) }], //Related measurements the observation is made from
    "component" : [{ BackboneElement }] // C?Used when reporting systolic and diastolic blood pressure.
  }

 

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

PathNameConformanceValueSet
Observation.languageCommon LanguagespreferredCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.codeVital SignsextensibleVital Signs
Observation.value[x].comparatorQuantityComparatorrequiredQuantityComparator
Observation.value[x].codeBody Weight UnitsrequiredBody Weight Units
Observation.dataAbsentReasonDataAbsentReasonextensibleDataAbsentReason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.typeObservation Reference Range Meaning CodespreferredObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToObservation Reference Range Applies To CodesexampleObservation Reference Range Applies To Codes
Observation.component.codeVital SignsextensibleVital Signs
Observation.component.value[x]Vital Signs UnitsrequiredVital Signs Units
Observation.component.dataAbsentReasonDataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
RuleRuleRule
IdPathDetailsRequirements
vs-1Observation.effective[x]Datetime must be at least to day.
Expression : ($this as dateTime).toString().length() >= 8
obs-3Observation.referenceRangeMust have at least a low or a high or text
Expression : low.exists() or high.exists() or text.exists()
vs-3Observation.componentIf there is no a value a data absent reason must be present
Expression : value.exists() or dataAbsentReason.exists()
.