US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Body Weight Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight Version: 10.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: USCoreBodyWeightProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.13

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Body Weight Profile inherits from the US Core Vital Signs Profile. This profile sets minimum expectations for the Observation resource to record, search, and fetch body weight observations with a standard LOINC code and UCUM units of measure. It specifies which additional core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

Mandatory and Must Support Data Elements

In addition to the Mandatory and Must Support data elements in the US Core Vital Signs Profile, the following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Note that the "Differential Table" displays elements unique to this profile and the "Key Elements Table” displays a combined view of elements for this profile and the US Core Vital Signs Profile.

Each Observation Must Have:

  1. a patient
  2. a fixed code for body weight

Each Observation Must Support:

  1. a result value1

1 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • The observations MAY have additional codes that translate or map to the Observation code or category codes.§ For example:
    • providing a local system-specific code
    • providing more specific codes such as 8306-3 - Body height - lying in addition to 8302-2 - Body height. Several additional observation codes are provided in the FHIR core specification vital signs table.

    A code system value SHOULD be supplied for each additional code.§

  • The observations MAY have component observations.§ For example, to qualify the vital sign observation, 8310-5 - Body temperature, 8327-9 - Body temperature measurement site (oral, forehead, rectal, etc.) may be used as a component observation. The FHIR core specification vital signs table provides several of these.
  • 1An Observation without a value, SHALL include a reason why the data is absent unless there are 1) component observations, or 2) reporting panel observations using Observation.hasMember.§,§
    • For further guidance, see the Observation Grouping section in FHIR Specification.
    • Systems that never provide an observation without a value MAY choose not to support Observation.dataAbsentReason.§
  • 1An Observation.component without a value, SHALL include a reason why the data is absent.§
    • Systems that never provide a component observation without a component value MAY choose not to support Observation.component.dataAbsentReason.§
  • Implementers may use this profile as a base for other vital signs in addition to those in this guide.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • No changes
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Constraints: obs-6, obs-7, vs-2
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required)
    Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:coding.code, value:coding.system
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:VSCat This element must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    Observation.Slices for category.category:VSCat.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
    Observation.Slices for category.category:VSCat.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: vital-signs (no extensions allowed)
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Body Weight
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.effective[x] This element must be supported. This element is included in summaries. C 1..1 Often just a dateTime for Vital Signs
    Constraints: vs-1
    Observation.effective[x].effectiveDateTime dateTime This target must be supported.
    Observation.effective[x].effectivePeriod Period
    Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Who is responsible for the observation
    Observation.Slices for value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Signs Value
    Slice: Unordered, Closed by type:$this
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
    Observation.Slices for value[x].valueQuantity Quantity This type must be supported.
    Observation.Slices for value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for value[x].valueString string
    Observation.Slices for value[x].valueBoolean boolean
    Observation.Slices for value[x].valueInteger integer
    Observation.Slices for value[x].valueRange Range
    Observation.Slices for value[x].valueRatio Ratio
    Observation.Slices for value[x].valueSampledData SampledData
    Observation.Slices for value[x].valueTime time
    Observation.Slices for value[x].valueDateTime dateTime
    Observation.Slices for value[x].valuePeriod Period
    Observation.Slices for value[x].value[x]:valueQuantity This element must be supported. This element is included in summaries. C 0..1 Quantity This type must be supported. Vital Signs Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.Slices for value[x].value[x]:valueQuantity.value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
    Observation.Slices for value[x].value[x]:valueQuantity.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
    Binding: QuantityComparator (required): How the Quantity should be understood and represented.
    Observation.Slices for value[x].value[x]:valueQuantity.unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
    Observation.Slices for value[x].value[x]:valueQuantity.system This element must be supported. This element is included in summaries. C 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.Slices for value[x].value[x]:valueQuantity.code This element must be supported. This element is included in summaries. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)
    Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component This element must be supported. This element is included in summaries. C 0..* BackboneElement Component observations
    Constraints: vs-3
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Coded vital sign result type
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Observation.component.value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Sign Component Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.component.value[x].valueQuantity Quantity This type must be supported.
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:VSCat Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueString Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueRange Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from USCoreVitalSignsProfile

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Observation.code This element must be supported. 1..1 CodeableConcept Body Weight
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.valueQuantity This element must be supported. 0..1 Quantity This type must be supported. Vital Signs Value
    Observation.valueQuantity.value This element must be supported. 1..1 decimal Numerical value (with implicit precision)
    Observation.valueQuantity.unit This element must be supported. 1..1 string Unit representation
    Observation.valueQuantity.system This element must be supported. 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.valueQuantity.code This element must be supported. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Constraints: obs-6, obs-7, vs-2
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.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
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required)
    Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:coding.code, value:coding.system
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:VSCat This element must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    Observation.Slices for category.category:VSCat.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for category.category:VSCat.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for category.category:VSCat.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
    Observation.Slices for category.category:VSCat.coding.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for category.category:VSCat.coding.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for category.category:VSCat.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
    Observation.Slices for category.category:VSCat.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: vital-signs (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.display This element is included in summaries. 0..1 string Representation defined by the system
    Observation.Slices for category.category:VSCat.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    Observation.Slices for category.category:VSCat.text This element is included in summaries. 0..1 string Plain text representation of the concept
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Body Weight
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.effective[x] This element must be supported. This element is included in summaries. C 1..1 Often just a dateTime for Vital Signs
    Constraints: vs-1
    Observation.effective[x].effectiveDateTime dateTime This target must be supported.
    Observation.effective[x].effectivePeriod Period
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Who is responsible for the observation
    Observation.Slices for value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Signs Value
    Slice: Unordered, Closed by type:$this
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
    Observation.Slices for value[x].valueQuantity Quantity This type must be supported.
    Observation.Slices for value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for value[x].valueString string
    Observation.Slices for value[x].valueBoolean boolean
    Observation.Slices for value[x].valueInteger integer
    Observation.Slices for value[x].valueRange Range
    Observation.Slices for value[x].valueRatio Ratio
    Observation.Slices for value[x].valueSampledData SampledData
    Observation.Slices for value[x].valueTime time
    Observation.Slices for value[x].valueDateTime dateTime
    Observation.Slices for value[x].valuePeriod Period
    Observation.Slices for value[x].value[x]:valueQuantity This element must be supported. This element is included in summaries. C 0..1 Quantity This type must be supported. Vital Signs Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.Slices for value[x].value[x]:valueQuantity.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for value[x].value[x]:valueQuantity.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for value[x].value[x]:valueQuantity.value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
    Observation.Slices for value[x].value[x]:valueQuantity.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
    Binding: QuantityComparator (required): How the Quantity should be understood and represented.
    Observation.Slices for value[x].value[x]:valueQuantity.unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
    Observation.Slices for value[x].value[x]:valueQuantity.system This element must be supported. This element is included in summaries. C 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.Slices for value[x].value[x]:valueQuantity.code This element must be supported. This element is included in summaries. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)
    Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Used when reporting vital signs panel components
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Related measurements the observation is made from
    Observation.component This element must be supported. This element is included in summaries. C 0..* BackboneElement Component observations
    Constraints: vs-3
    Observation.component.id 0..1 string Unique id for inter-element referencing
    Observation.component.extension 0..* Extension Additional content defined by implementations
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Coded vital sign result type
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Observation.component.value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Sign Component Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.component.value[x].valueQuantity Quantity This type must be supported.
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:VSCat Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueString Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueRange Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from USCoreVitalSignsProfile

    Summary

    Mandatory: 0 element(4 nested mandatory elements)
    Must-Support: 6 elements
    Fixed: 1 element

    Maturity: 5

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Constraints: obs-6, obs-7, vs-2
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required)
    Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:coding.code, value:coding.system
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:VSCat This element must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    Observation.Slices for category.category:VSCat.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
    Observation.Slices for category.category:VSCat.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: vital-signs (no extensions allowed)
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Body Weight
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.effective[x] This element must be supported. This element is included in summaries. C 1..1 Often just a dateTime for Vital Signs
    Constraints: vs-1
    Observation.effective[x].effectiveDateTime dateTime This target must be supported.
    Observation.effective[x].effectivePeriod Period
    Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Who is responsible for the observation
    Observation.Slices for value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Signs Value
    Slice: Unordered, Closed by type:$this
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
    Observation.Slices for value[x].valueQuantity Quantity This type must be supported.
    Observation.Slices for value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for value[x].valueString string
    Observation.Slices for value[x].valueBoolean boolean
    Observation.Slices for value[x].valueInteger integer
    Observation.Slices for value[x].valueRange Range
    Observation.Slices for value[x].valueRatio Ratio
    Observation.Slices for value[x].valueSampledData SampledData
    Observation.Slices for value[x].valueTime time
    Observation.Slices for value[x].valueDateTime dateTime
    Observation.Slices for value[x].valuePeriod Period
    Observation.Slices for value[x].value[x]:valueQuantity This element must be supported. This element is included in summaries. C 0..1 Quantity This type must be supported. Vital Signs Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.Slices for value[x].value[x]:valueQuantity.value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
    Observation.Slices for value[x].value[x]:valueQuantity.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
    Binding: QuantityComparator (required): How the Quantity should be understood and represented.
    Observation.Slices for value[x].value[x]:valueQuantity.unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
    Observation.Slices for value[x].value[x]:valueQuantity.system This element must be supported. This element is included in summaries. C 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.Slices for value[x].value[x]:valueQuantity.code This element must be supported. This element is included in summaries. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)
    Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component This element must be supported. This element is included in summaries. C 0..* BackboneElement Component observations
    Constraints: vs-3
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Coded vital sign result type
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Observation.component.value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Sign Component Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.component.value[x].valueQuantity Quantity This type must be supported.
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:VSCat Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueString Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueRange Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    Differential View

    This structure is derived from USCoreVitalSignsProfile

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Observation.code This element must be supported. 1..1 CodeableConcept Body Weight
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.valueQuantity This element must be supported. 0..1 Quantity This type must be supported. Vital Signs Value
    Observation.valueQuantity.value This element must be supported. 1..1 decimal Numerical value (with implicit precision)
    Observation.valueQuantity.unit This element must be supported. 1..1 string Unit representation
    Observation.valueQuantity.system This element must be supported. 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.valueQuantity.code This element must be supported. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* USCoreVitalSignsProfile US Core Body Weight Profile
    Constraints: obs-6, obs-7, vs-2
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.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
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required)
    Observation.Slices for category This element must be supported. 1..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:coding.code, value:coding.system
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:VSCat This element must be supported. 1..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
    Observation.Slices for category.category:VSCat.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for category.category:VSCat.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for category.category:VSCat.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
    Observation.Slices for category.category:VSCat.coding.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for category.category:VSCat.coding.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for category.category:VSCat.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
    Observation.Slices for category.category:VSCat.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
    Fixed Value: vital-signs (no extensions allowed)
    Observation.Slices for category.category:VSCat.coding.display This element is included in summaries. 0..1 string Representation defined by the system
    Observation.Slices for category.category:VSCat.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
    Observation.Slices for category.category:VSCat.text This element is included in summaries. 0..1 string Plain text representation of the concept
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Body Weight
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "29463-7"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.effective[x] This element must be supported. This element is included in summaries. C 1..1 Often just a dateTime for Vital Signs
    Constraints: vs-1
    Observation.effective[x].effectiveDateTime dateTime This target must be supported.
    Observation.effective[x].effectivePeriod Period
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Who is responsible for the observation
    Observation.Slices for value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Signs Value
    Slice: Unordered, Closed by type:$this
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
    Observation.Slices for value[x].valueQuantity Quantity This type must be supported.
    Observation.Slices for value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for value[x].valueString string
    Observation.Slices for value[x].valueBoolean boolean
    Observation.Slices for value[x].valueInteger integer
    Observation.Slices for value[x].valueRange Range
    Observation.Slices for value[x].valueRatio Ratio
    Observation.Slices for value[x].valueSampledData SampledData
    Observation.Slices for value[x].valueTime time
    Observation.Slices for value[x].valueDateTime dateTime
    Observation.Slices for value[x].valuePeriod Period
    Observation.Slices for value[x].value[x]:valueQuantity This element must be supported. This element is included in summaries. C 0..1 Quantity This type must be supported. Vital Signs Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.Slices for value[x].value[x]:valueQuantity.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for value[x].value[x]:valueQuantity.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Observation.Slices for value[x].value[x]:valueQuantity.value This element must be supported. This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
    Observation.Slices for value[x].value[x]:valueQuantity.comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
    Binding: QuantityComparator (required): How the Quantity should be understood and represented.
    Observation.Slices for value[x].value[x]:valueQuantity.unit This element must be supported. This element is included in summaries. 1..1 string Unit representation
    Observation.Slices for value[x].value[x]:valueQuantity.system This element must be supported. This element is included in summaries. C 1..1 uri System that defines coded unit form
    Fixed Value: http://unitsofmeasure.org (no extensions allowed)
    Observation.Slices for value[x].value[x]:valueQuantity.code This element must be supported. This element is included in summaries. 1..1 code Coded responses from the common UCUM units for vital signs value set.
    Binding: BodyWeightUnits (required)
    Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Used when reporting vital signs panel components
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) Related measurements the observation is made from
    Observation.component This element must be supported. This element is included in summaries. C 0..* BackboneElement Component observations
    Constraints: vs-3
    Observation.component.id 0..1 string Unique id for inter-element referencing
    Observation.component.extension 0..* Extension Additional content defined by implementations
    Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Coded vital sign result type
    Binding: Vital Sign Result Type (extensible): Vital sign result types
    Observation.component.value[x] This element must be supported. This element is included in summaries. C 0..1 Vital Sign Component Value
    Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
    Observation.component.value[x].valueQuantity Quantity This type must be supported.
    Observation.component.value[x].valueCodeableConcept CodeableConcept
    Observation.component.value[x].valueString string
    Observation.component.value[x].valueBoolean boolean
    Observation.component.value[x].valueInteger integer
    Observation.component.value[x].valueRange Range
    Observation.component.value[x].valueRatio Ratio
    Observation.component.value[x].valueSampledData SampledData
    Observation.component.value[x].valueTime time
    Observation.component.value[x].valueDateTime dateTime
    Observation.component.value[x].valuePeriod Period
    Observation.component.dataAbsentReason This element must be supported. C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:VSCat Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
    Observation.value[x]:valueQuantity.​code Base required Body Weight Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueString Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.value[x]:valueRange Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base extensible Vital Sign Result Type ⏿20251202 tx.fhir.org
    Observation.component.​value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from USCoreVitalSignsProfile

    Summary

    Mandatory: 0 element(4 nested mandatory elements)
    Must-Support: 6 elements
    Fixed: 1 element

    Maturity: 5

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to vital signs data SHALL support these US Core SMART Scopes:

    • resource level scopes: <patient|user|system>/Observation.rs §

    • granular scopes: <patient|user|system>/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs §


    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching for all Observations using the combination of the patient and category search parameters

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and a category code = "vital-signs" ( see how to search by reference and how to search by token).

    2. SHALL support searching for all Observations by code using the combination of the patient and code search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={Patient/}[id]&code={system|}[search_code]{,{system|}[code],...}

      Examples:

      1. GET [base]/Observation?patient=Patient/1137192&code=http://loinc.org|29463-7

      2. GET [base]/Observation?patient=Patient/1137192&code=http://loinc.org|29463-7,http://loinc.org|39156-5,

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and observation code(s). SHOULD support search by multiple codes. The US Core Body Weight Profile "code" parameter searches only .code and not component.code. ( see how to search by reference and how to search by token).

    3. SHALL support searching for all Observations by date (for example, results after 2018) using the combination of the patient and category and date search parameters

      • Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)

      • Including support for these date comparators: "gt", "lt", "ge", "le"

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&date=ge2018-03-14T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and date and a category code = "vital-signs" ( see how to search by reference and how to search by token and how to search by date).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support searching for all Observations for a patient for a given status (for example all observations marked as final) using the combination of the patient and category and status search parameters

      • Including support OR search on status (e.g.status={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&status={system|}[search_code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&status=final

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and category = "vital-signs" and status ( see how to search by reference and how to search by token).

    2. SHOULD support searching using the combination of the patient and category and _lastUpdated search parameters

      • Including optional support for AND search on _lastUpdated (e.g._lastUpdated=[date]&_lastUpdated=[date]&...)

      • Including support for these _lastUpdated comparators: "gt", "lt", "ge", "le"

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&_lastUpdated=[dateTime]

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&_lastUpdated=ge2024-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and category code = "vital-signs" and _lastUpdated. See the US Core General Guidance page for Searching Using lastUpdated. ( see how to search by reference and how to search by token and how to search by date).

    3. SHOULD support searching Observations by code and date using the combination of the patient and code and date search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

      • Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)

      • Including support for these date comparators: "gt", "lt", "ge", "le"

      GET [base]/Observation?patient={Patient/}[id]&code={system|}[search_code]{,{system|}[code],...}&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&code=http://loinc.org|29463-7&date=ge2019-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Body Weight Profile resources for the specified patient and date and code(s). SHOULD support search by multiple codes. ( see how to search by reference and how to search by token and how to search by date).