1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Observation

Update an observation

put

/Observation/{ID}

Updates an existing observation.

Note:

  • Currently, only laboratory and vital-signs are supported.
  • Both read and write scopes are required.
  • Updates to patient and category are not supported.
  • Components are only supported for vital-sign blood pressure and pulse oximetry profiles.
  • See FHIR Update for additional details about update operations.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : ObservationUpdateBody
Type: object
Show Source
  • The logical ID of the resource to update. The ID value must match the Observation/ value.
    Example: p123412
  • identifier
    A unique identifier assigned to the observation.
    Note: Identifier is required for Vital Signs and it cannot be modified. Identifier is optional for Laboratory.
Match All
Show Source
Example:
{
  "resourceType": "Observation",
  "id": "VS-197356031",
  "identifier": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CE87caf4b7-9397-4667-9897-702218017c9e-197356031-2021061619245900"
    }
  ],
  "status": "corrected",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/d242a518-4074-4bd4-a3a6-adfe0c5c1c51/codeSet/72",
        "code": "703558",
        "display": "Temperature Oral",
        "userSelected": true
      }
    ],
    "text": "Temperature Oral"
  },
  "subject": {
    "reference": "Patient/12457979"
  },
  "encounter": {
    "reference": "Encounter/97787491"
  },
  "effectiveDateTime": "2020-07-04T07:15:00.000Z",
  "issued": "2021-05-06T20:07:14.000Z",
  "performer": [
    {
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "LA",
                "display": "legal authenticator"
              }
            ],
            "text": "legal authenticator"
          },
          "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
        }
      ],
      "reference": "Practitioner/1"
    }
  ],
  "valueQuantity": {
    "value": 123,
    "unit": "mmHg",
    "system": "http://unitsofmeasure.org",
    "code": "mm[Hg]"
  }
}
Nested Schema : identifier
Type: object
A unique identifier assigned to the observation.
Note: Identifier is required for Vital Signs and it cannot be modified. Identifier is optional for Laboratory.
Example:
{
  "system":"https://fhir.cerner.com/ceuuid",
  "value":"CE87caf4b7-9397-4667-9897-702218017c9e-197356031-2021061619245900"
}
Nested Schema : ObservationCreateBody
Type: object
Show Source
  • category
    A code that classifies the general type of observation being made.
    Note:
    • VitalSigns and Laboratory categories are supported.
    • Only one category may be supplied on create.
    Example: 
    {
  "category": [
    {
      "coding": [
        {
          "system": 'http://terminology.hl7.org/CodeSystem/observation-category',
          "code": 'vital-signs',
          "display": 'Vital Signs'
        }
      ],
      "text": 'Vital Signs'
    }
  ]
}
  • code
    Describes what was observed. Also called the observation name.
    Example: 
    {
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8331-1'
      }
    ],
    "text": 'Temperature Oral'
  }
}
    {
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8302-2'
      },
      {
        "system": 'http://loinc.org',
        "code": '3137-7'
      }
    ],
    "text": 'Height/Length Measured'
  }
}
  • component
    Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
    Note: Component is required to create blood pressure.
    Example: 
    {
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8480-6'
      }
    ],
    "text": 'Systolic Blood Pressure Invasive'
  },
  "valueQuantity": {
    "value": 120,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "interpretation": [
    {
      "coding": [
        {
          "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
          "code": 'N'
        }
      ]
    }
  ],
  "referenceRange": [
    {
      "low": {
        "value": 45.0,
        "unit": 'mmHg',
        "system": 'http://unitsofmeasure.org',
        "code": 'mm[Hg]'
      },
      "high": {
        "value": 75.0,
        "unit": 'mmHg',
        "system": 'http://unitsofmeasure.org',
        "code": 'mm[Hg]'
      },
      "type": {
        "coding": [
          {
            "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
            "code": 'normal'
          }
        ],
        "text": 'Normal Range'
      }
    }
  ]
}
  • component.code
    Describes what was observed. Also called the observation name.
    Example: 
    {
  "coding": [
    {
      "system": 'http://loinc.org',
      "code": '8480-6'
    }
  ],
  "text": 'Systolic Blood Pressure Invasive'
}
  • component.interpretation
    A categorical assessment of an observation value. For example, high, low, normal.
    Note: Only one interpretation may be supplied.
    Example: 
    {
   "coding": [
     {
       "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
       "code": 'N'
     }
   ],
   "text": 'NORMAL'
 }
  • component.referenceRange
    Guidance on how to interpret the value by comparison to a normal or recommended range.
    Note:
    • Only one referenceRange is supported.
    • ReferenceRange.text is not supported when referenceRange.high, referenceRange.low, or both are provided. Only a referenceRange.type of normal is supported.
    Example: 
    {
  "low": {
    "value": 45.0,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "high": {
    "value": 75.0,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "type": {
    "coding": [
      {
        "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
        "code": 'normal'
      }
    ],
    "text": 'Normal Range'
  }
}
  • The information determined as a result of making the observation, if the information has a simple value.
    Note: Supports writing observations with only valueQuantity.
    Example: 
    {
  "value": 120,
  "unit": 'mmHg',
  "system": 'http://unitsofmeasure.org',
  "code": 'mm[Hg]'
}
  • The date and time when the observation was made.
    Note: Only a type of dateTime is supported.
    Example: 
    {
  "effectiveDateTime": "2020-07-07T20:37:00.000Z"
}
  • encounter
    The encounter during which the observation was first made.
    Example: 
    {
  "encounter": {
    "reference": "Encounter/631923"
  }
}
  • interpretation
    A categorical assessment of an observation value. For example, high, low, normal.
    Note: Only one interpretation may be supplied.
    Example: 
    {
  "interpretation": [
    {
      "coding": [
        {
          "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/52',
          "code": '211',
          "display": 'LOW',
          "userSelected": true
        }
      ],
      "text": 'LOW'
    }
  ]
}
    {
  "interpretation": [
    {
      "coding": [
        {
          {
            "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
            "code": 'L',
            "display": 'Low'
          }
        ],
        "text": 'LOW'
      }
    ]
  }
  • The instant the observation was made.
    Example: 
    {
  "issued": "2020-07-06T21:02:47.000Z"
}
  • note
    Comments about the observation
    Example: 
    {
  "note": [
    {
      "authorReference": {
        "reference": 'Practitioner/62955753'
      },
      "time": '2018-08-17T09:55:42.000Z',
      "text": 'Charted at Incorrect Time'
    }
  ]
}
  • performer
    Limited to "real" people rather than equipment.
    Note:
    • Must be a reference to a practitioner.
    • Vital signs require a performer.
    Example: 
    {
"performer": [
    {
        "reference": 'Practitioner/12724064'
      }
  ]
}
  • performer.extension
    Distinguishes the performer's type of involvement in the event.
    Note:
    • Vital signs support LA and PPRF codes.
      • When only one performer is provided, the code must be LA.
      • When multiple performers are provided, the code must be LA for one of the performers.
    • Laboratory supports LA, PPRF, PRF, OP, and AUTHEN codes.
    Example: 
    {
   "extension": [
     {
       "valueCodeableConcept": {
         "coding": [
           {
             "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType',
             "code": 'LA',
             "display": 'legal authenticator'
           }
         ],
         "text": 'legal authenticator'
       },
       "url": 'http://hl7.org/fhir/StructureDefinition/event-performerFunction'
     }
   ],
 }
    {
   "extension": [
      {
         "valueCodeableConcept": {
            "coding": [
               {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0912",
                  "code": "OP",
                  "display": "ordering provider"
               }
            ],
            "text": "ordering provider"
         },
         "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept": {
            "coding": [
               {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code": "PPRF",
                  "display": "primary performer"
               }
            ],
            "text": "primary performer"
         },
         "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept":{
            "coding":[
               {
                  "system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code":"PRF",
                  "display":"performer"
               }
            ],
            "text":"performer"
         },
         "url":"http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept":{
            "coding":[
               {
                  "system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code":"AUTHEN",
                  "display":"authenticator"
               }
            ],
            "text":"authenticator"
         },
         "url":"http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      }
   ]
}
  • referenceRange
    Provides guidance for interpretating the observation.
    Note:
    • Only one referenceRange is supported.
    • ReferenceRange.text is not supported when referenceRange.high, referenceRange.low, or both are provided. Only a referenceRange.type of normal is supported.
    Example: 
    {
  "referenceRange": [
    {
      "low": {
        "value": 35.2,
        "unit": 'degC',
        "system": 'http://unitsofmeasure.org',
        "code": 'Cel'
      },
      "high": {
        "value": 36.7,
        "unit": 'degC',
        "system": 'http://unitsofmeasure.org',
        "code": 'Cel'
      },
      "type": {
        "coding": [
          {
            "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
            "code": 'normal',
            "display": 'Normal Range'
          }
        ],
        "text": 'Normal Range'
      }
    }
  ]
}
  • referenceRange.high
    The upper bound of the reference range.
    Example: 
    {
  "low": {
    "value": 36.7,
    "unit": 'degC',
    "system": 'http://unitsofmeasure.org',
    "code": 'Cel'
  }
}
  • referenceRange.low
    The lower bound of the reference range.
    Example: 
    {
  "low": {
    "value": 35.2,
    "unit": 'degC',
    "system": 'http://unitsofmeasure.org',
    "code": 'Cel'
  }
}
  • The text-based reference range in an observation, which may be used when a quantitative range is not appropriate for an observation.
    Example: 
    {
  "text": 'Negative'
}
  • referenceRange.type
    Codes to indicate what part of the targeted reference population it applies to.
    Note: Only a ReferenceRange.type of normal is supported.
    Example: 
    {
  "type": {
    "coding": [
      {
        "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
        "code": 'normal',
        "display": 'Normal Range'
      }
    ],
    "text": 'Normal Range'
  }
}
  • Allowed Values: [ "Observation" ]
    The type of the FHIR resource.
  • Codes identifying the lifecycle stage of an event.
    Note: The final, amended, and corrected status codes are supported.
    Example: 
    {
  "status": "final"
}
  • subject
    Indicates the patient who the observation record is associated with.
    Note: Must only include references to a patient.
    Example: 
    {
  "subject": {
    "reference": "Patient/631923"
  }
}
  • The value of the observation.
    Note:
    • Vital signs support writing observations with valueQuantity.
    • Laboratory supports valueQuantity, valueCodeableConcept, valueString, valueAttachment, and valueDateTime.
    Example: 
    {
  "valueQuantity":
  {
    "value": 162,
    "unit": 'cm',
    "system": 'http://unitsofmeasure.org',
    "code": 'cm'
  }
}
    {
  "valueCodeableConcept": {
    "coding": [
      {
        "system": 'http://snomed.info/sct',
        "code": '373066001',
        "display": 'Yes (qualifier value)'
      }
    ],
    "text": 'Yes'
  }
}

    {
  "valueString": '2'
}

    {
  "valueDateTime": '2020-07-04T07:15:00Z'
}
Example:
{
  "resourceType": "Observation",
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "8331-1"
      }
    ],
    "text": "Temperature Oral"
  },
  "subject": {
    "reference": "Patient/12457981"
  },
  "encounter": {
    "reference": "Encounter/97845408"
  },
  "effectiveDateTime": "2020-04-03T19:21:00.000Z",
  "issued": "2020-04-03T19:21:40.000Z",
  "performer": [
    {
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "LA",
                "display": "legal authenticator"
              }
            ],
            "text": "legal authenticator"
          },
          "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
        }
      ],
      "reference": "Practitioner/11638321"
    }
  ],
  "valueQuantity": {
    "value": 37.2,
    "unit": "degC",
    "system": "http://unitsofmeasure.org",
    "code": "Cel"
  },
  "interpretation": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
          "code": "N",
          "display": "Normal"
        }
      ]
    }
  ],
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/11638321"
      },
      "time": "2020-09-03T15:03:10.000Z",
      "text": "No additional test require"
    }
  ],
  "referenceRange": [
    {
      "low": {
        "value": 35.8,
        "unit": "degC",
        "system": "http://unitsofmeasure.org",
        "code": "Cel"
      },
      "high": {
        "value": 37.3,
        "unit": "degC",
        "system": "http://unitsofmeasure.org",
        "code": "Cel"
      },
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
            "code": "normal",
            "display": "Normal Range"
          }
        ],
        "text": "Normal Range"
      }
    }
  ]
}
Nested Schema : ObservationUpdateBody-allOf[1]
Type: object
Nested Schema : category
Type: array
A code that classifies the general type of observation being made.
Note:
  • VitalSigns and Laboratory categories are supported.
  • Only one category may be supplied on create.
Example: 
{
  "category": [
    {
      "coding": [
        {
          "system": 'http://terminology.hl7.org/CodeSystem/observation-category',
          "code": 'vital-signs',
          "display": 'Vital Signs'
        }
      ],
      "text": 'Vital Signs'
    }
  ]
}
Show Source
Nested Schema : code
Type: object
Describes what was observed. Also called the observation name.
Example: 
{
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8331-1'
      }
    ],
    "text": 'Temperature Oral'
  }
}
{
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8302-2'
      },
      {
        "system": 'http://loinc.org',
        "code": '3137-7'
      }
    ],
    "text": 'Height/Length Measured'
  }
}
Show Source
Nested Schema : component
Type: array
Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
Note: Component is required to create blood pressure.
Example: 
{
  "code": {
    "coding": [
      {
        "system": 'http://loinc.org',
        "code": '8480-6'
      }
    ],
    "text": 'Systolic Blood Pressure Invasive'
  },
  "valueQuantity": {
    "value": 120,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "interpretation": [
    {
      "coding": [
        {
          "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
          "code": 'N'
        }
      ]
    }
  ],
  "referenceRange": [
    {
      "low": {
        "value": 45.0,
        "unit": 'mmHg',
        "system": 'http://unitsofmeasure.org',
        "code": 'mm[Hg]'
      },
      "high": {
        "value": 75.0,
        "unit": 'mmHg',
        "system": 'http://unitsofmeasure.org',
        "code": 'mm[Hg]'
      },
      "type": {
        "coding": [
          {
            "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
            "code": 'normal'
          }
        ],
        "text": 'Normal Range'
      }
    }
  ]
}
Show Source
Nested Schema : component.code
Type: object
Describes what was observed. Also called the observation name.
Example: 
{
  "coding": [
    {
      "system": 'http://loinc.org',
      "code": '8480-6'
    }
  ],
  "text": 'Systolic Blood Pressure Invasive'
}
Show Source
Nested Schema : component.interpretation
Type: array
A categorical assessment of an observation value. For example, high, low, normal.
Note: Only one interpretation may be supplied.
Example: 
{
   "coding": [
     {
       "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
       "code": 'N'
     }
   ],
   "text": 'NORMAL'
 }
Show Source
Nested Schema : component.referenceRange
Type: object
Guidance on how to interpret the value by comparison to a normal or recommended range.
Note:
  • Only one referenceRange is supported.
  • ReferenceRange.text is not supported when referenceRange.high, referenceRange.low, or both are provided. Only a referenceRange.type of normal is supported.
Example: 
{
  "low": {
    "value": 45.0,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "high": {
    "value": 75.0,
    "unit": 'mmHg',
    "system": 'http://unitsofmeasure.org',
    "code": 'mm[Hg]'
  },
  "type": {
    "coding": [
      {
        "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
        "code": 'normal'
      }
    ],
    "text": 'Normal Range'
  }
}
Show Source
Nested Schema : encounter
Type: object
The encounter during which the observation was first made.
Example: 
{
  "encounter": {
    "reference": "Encounter/631923"
  }
}
Show Source
Nested Schema : interpretation
Type: array
A categorical assessment of an observation value. For example, high, low, normal.
Note: Only one interpretation may be supplied.
Example: 
{
  "interpretation": [
    {
      "coding": [
        {
          "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/52',
          "code": '211',
          "display": 'LOW',
          "userSelected": true
        }
      ],
      "text": 'LOW'
    }
  ]
}
{
  "interpretation": [
    {
      "coding": [
        {
          {
            "system": 'http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation',
            "code": 'L',
            "display": 'Low'
          }
        ],
        "text": 'LOW'
      }
    ]
  }
Show Source
Nested Schema : note
Type: array
Comments about the observation
Example: 
{
  "note": [
    {
      "authorReference": {
        "reference": 'Practitioner/62955753'
      },
      "time": '2018-08-17T09:55:42.000Z',
      "text": 'Charted at Incorrect Time'
    }
  ]
}
Show Source
Nested Schema : performer
Type: array
Limited to "real" people rather than equipment.
Note:
  • Must be a reference to a practitioner.
  • Vital signs require a performer.
Example: 
{
"performer": [
    {
        "reference": 'Practitioner/12724064'
      }
  ]
}
Show Source
Nested Schema : performer.extension
Type: object
Distinguishes the performer's type of involvement in the event.
Note:
  • Vital signs support LA and PPRF codes.
    • When only one performer is provided, the code must be LA.
    • When multiple performers are provided, the code must be LA for one of the performers.
  • Laboratory supports LA, PPRF, PRF, OP, and AUTHEN codes.
Example: 
{
   "extension": [
     {
       "valueCodeableConcept": {
         "coding": [
           {
             "system": 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType',
             "code": 'LA',
             "display": 'legal authenticator'
           }
         ],
         "text": 'legal authenticator'
       },
       "url": 'http://hl7.org/fhir/StructureDefinition/event-performerFunction'
     }
   ],
 }
{
   "extension": [
      {
         "valueCodeableConcept": {
            "coding": [
               {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0912",
                  "code": "OP",
                  "display": "ordering provider"
               }
            ],
            "text": "ordering provider"
         },
         "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept": {
            "coding": [
               {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code": "PPRF",
                  "display": "primary performer"
               }
            ],
            "text": "primary performer"
         },
         "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept":{
            "coding":[
               {
                  "system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code":"PRF",
                  "display":"performer"
               }
            ],
            "text":"performer"
         },
         "url":"http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      },
      {
         "valueCodeableConcept":{
            "coding":[
               {
                  "system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code":"AUTHEN",
                  "display":"authenticator"
               }
            ],
            "text":"authenticator"
         },
         "url":"http://hl7.org/fhir/StructureDefinition/event-performerFunction"
      }
   ]
}
Nested Schema : referenceRange
Type: array
Provides guidance for interpretating the observation.
Note:
  • Only one referenceRange is supported.
  • ReferenceRange.text is not supported when referenceRange.high, referenceRange.low, or both are provided. Only a referenceRange.type of normal is supported.
Example: 
{
  "referenceRange": [
    {
      "low": {
        "value": 35.2,
        "unit": 'degC',
        "system": 'http://unitsofmeasure.org',
        "code": 'Cel'
      },
      "high": {
        "value": 36.7,
        "unit": 'degC',
        "system": 'http://unitsofmeasure.org',
        "code": 'Cel'
      },
      "type": {
        "coding": [
          {
            "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
            "code": 'normal',
            "display": 'Normal Range'
          }
        ],
        "text": 'Normal Range'
      }
    }
  ]
}
Show Source
Nested Schema : referenceRange.high
Type: object
The upper bound of the reference range.
Example: 
{
  "low": {
    "value": 36.7,
    "unit": 'degC',
    "system": 'http://unitsofmeasure.org',
    "code": 'Cel'
  }
}
Show Source
Nested Schema : referenceRange.low
Type: object
The lower bound of the reference range.
Example: 
{
  "low": {
    "value": 35.2,
    "unit": 'degC',
    "system": 'http://unitsofmeasure.org',
    "code": 'Cel'
  }
}
Show Source
Nested Schema : referenceRange.type
Type: object
Codes to indicate what part of the targeted reference population it applies to.
Note: Only a ReferenceRange.type of normal is supported.
Example: 
{
  "type": {
    "coding": [
      {
        "system": 'http://terminology.hl7.org/CodeSystem/referencerange-meaning',
        "code": 'normal',
        "display": 'Normal Range'
      }
    ],
    "text": 'Normal Range'
  }
}
Show Source
Nested Schema : subject
Type: object
Indicates the patient who the observation record is associated with.
Note: Must only include references to a patient.
Example: 
{
  "subject": {
    "reference": "Patient/631923"
  }
}
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorReference
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

This operation supports the following authorization types: Example Request: 
PUT https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Observation/L-196186655
-d '{
  "resourceType": "Observation",
  "id": "L-196186655",
  "status": "corrected",
  "meta": {
    "source": "43ba6d6a-1006-4546-bf28-48d84a98dbb1"
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "laboratory",
          "display": "Laboratory"
        }
      ],
      "text": "Laboratory"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
        "code": "21704910",
        "display": "Potassium Level",
        "userSelected": true
      }
    ],
    "text": "Potassium Level"
  },
  "subject": {
    "reference": "Patient/12457981"
  },
  "encounter": {
    "reference": "Encounter/2673896"
  },
  "issued": "2020-07-30T20:42:00.000Z",
  "effectiveDateTime": "2020-07-30T20:42:00.000Z",
  "performer": [
    {
      "reference": "Practitioner/1477926"
    }
  ],
  "valueQuantity": {
    "value": 13.2,
    "unit": "mg/dL",
    "system": "http://unitsofmeasure.org",
    "code": "mg/dL"
  },
  "interpretation": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
          "code": "N",
          "display": "Normal"
        }
      ],
      "text": "Normal"
    }
  ],
  "referenceRange": [
    {
      "low": {
        "value": 12.0,
        "unit": "g/dL",
        "system": "http://unitsofmeasure.org",
        "code": "g/dL"
      },
      "high": {
        "value": 15.5,
        "unit": "g/dL",
        "system": "http://unitsofmeasure.org",
        "code": "g/dL"
      }
    }
  ],
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/1477926"
      },
      "time": "2020-07-30T20:42:15.000Z",
      "text": "Specimen slightly hemolyzed."
    }
  ]
}
Example Response: 
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 20 Aug 2019 21:17:04 GMT
Etag: W/"12809861"
Last-Modified: TTue, 20 Aug 2019 21:17:04 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers

x-vitals-blood-pressure Response

Note: This resource action is still under development.
This operation supports the following authorization types: Example Request: 
PUT https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Observation/BP-59857018-59857020
-d '{
  "resourceType": "Observation",
  "id": "BP-59857018-59857020",
  "identifier": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-59857018-2022111805415000"
    },
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-59857020-2022111805415000"
    }
  ],
  "status": "corrected",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "85354-9",
        "display": "Blood pressure panel with all children optional"
      }
    ],
    "text": "Blood pressure"
  },
  "subject": {
    "reference": "Patient/15116458"
  },
  "encounter": {
    "reference": "Encounter/15687784"
  },
  "effectiveDateTime": "2022-06-09T08:00:58.000Z",
  "issued": "2022-06-09T08:00:58.000Z",
  "performer": [
    {
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "LA",
                "display": "legal authenticator"
              }
            ],
            "text": "legal authenticator"
          },
          "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
        }
      ],
      "reference": "Practitioner/15441459"
    }
  ],
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8480-6"
          }
        ],
        "text": "Systolic Blood Pressure Sitting"
      },
      "valueQuantity": {
        "value": 99,
        "unit": "mmHg",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      },
      "interpretation": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
              "code": "N",
              "display": "Normal"
            }
          ]
        }
      ],
      "referenceRange": [
        {
          "low": {
            "value": 35,
            "unit": "mmHg",
            "system": "http://unitsofmeasure.org",
            "code": "mm[Hg]"
          },
          "high": {
            "value": 37,
            "unit": "mmHg",
            "system": "http://unitsofmeasure.org",
            "code": "mm[Hg]"
          },
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                "code": "normal",
                "display": "Normal Range"
              }
            ],
            "text": "Normal Range"
          }
        }
      ]
    },
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8462-4"
          }
        ],
        "text": "Diastolic Blood Pressure Sitting"
      },
      "valueQuantity": {
        "value": 66,
        "unit": "mmHg",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      },
      "interpretation": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
              "code": "N",
              "display": "Normal"
            }
          ]
        }
      ],
      "referenceRange": [
        {
          "low": {
            "value": 35,
            "unit": "mmHg",
            "system": "http://unitsofmeasure.org",
            "code": "mm[Hg]"
          },
          "high": {
            "value": 37,
            "unit": "mmHg",
            "system": "http://unitsofmeasure.org",
            "code": "mm[Hg]"
          },
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                "code": "normal",
                "display": "Normal Range"
              }
            ],
            "text": "Normal Range"
          }
        }
      ]
    }
  ]
}
Example Response: 
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 20 Aug 2019 21:17:04 GMT
Etag: W/"12809861"
Last-Modified: TTue, 20 Aug 2019 21:17:04 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers

x-vitals-body Response

This operation supports the following authorization types: Example Request: 
PUT https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Observation/VS-197356031
-d '{
  "resourceType": "Observation",
  "id": "VS-197356031",
  "identifier": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CE87caf4b7-9397-4667-9897-702218017c9e-197356031-2021061619245900"
    }
  ],
  "status": "corrected",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/d242a518-4074-4bd4-a3a6-adfe0c5c1c51/codeSet/72",
        "code": "703558",
        "display": "Temperature Oral",
        "userSelected": true
      }
    ],
    "text": "Temperature Oral"
  },
  "subject": {
    "reference": "Patient/12457979"
  },
  "encounter": {
    "reference": "Encounter/97787491"
  },
  "effectiveDateTime": "2020-07-04T07:15:00.000Z",
  "issued": "2021-05-06T20:07:14.000Z",
  "performer": [
    {
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "LA",
                "display": "legal authenticator"
              }
            ],
            "text": "legal authenticator"
          },
          "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
        }
      ],
      "reference": "Practitioner/1"
    }
  ],
  "valueQuantity": {
    "value": 123,
    "unit": "mmHg",
    "system": "http://unitsofmeasure.org",
    "code": "mm[Hg]"
  }
}
Example Response: 
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 20 Aug 2019 21:17:04 GMT
Etag: W/"12809861"
Last-Modified: TTue, 20 Aug 2019 21:17:04 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers

x-vitals-pulse-oxymetry Response

Note: This resource action is still under development.
This operation supports the following authorization types: Example Request: 
PUT https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Observation/VS-CV-78693473-SECT-8098
-d '{
  "resourceType": "Observation",
  "id": "VS-CV-83059963-SECT-8098",
  "identifier": [
    {
      "system": "https://fhir.cerner.com/cvuuid",
      "value": "8344a9b7-b1b7-406e-b303-1009edd66459"
    }
  ],
  "status": "amended",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "2708-6",
        "display": "Oxygen saturation in Arterial blood"
      },
      {
        "system": "http://loinc.org",
        "code": "59408-5",
        "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
      }
    ],
    "text": "SpO2"
  },
  "subject": {
    "reference": "Patient/12457979"
  },
  "encounter": {
    "reference": "Encounter/97787491"
  },
  "effectiveDateTime": "2022-06-05T08:00:38.022Z",
  "issued": "2022-06-05T08:00:56Z",
  "performer": [
    {
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "LA",
                "display": "legal authenticator"
              }
            ],
            "text": "legal authenticator"
          },
          "url": "http://hl7.org/fhir/StructureDefinition/event-performerFunction"
        }
      ],
      "reference": "Practitioner/15441459"
    }
  ],
  "valueQuantity": {
    "value": 44,
    "unit": "%",
    "system": "http://unitsofmeasure.org",
    "code": "%"
  },
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "3151-8",
            "display": "Inhaled oxygen flow rate"
          }
        ],
        "text": "Oxygen Flow Rate"
      },
      "valueQuantity": {
        "value": 55,
        "unit": "L/min",
        "system": "http://unitsofmeasure.org",
        "code": "L/min"
      }
    },
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "3150-0",
            "display": "Inhaled oxygen concentration"
          }
        ],
        "text": "FIO2"
      },
      "valueQuantity": {
        "value": 66,
        "unit": "%",
        "system": "http://unitsofmeasure.org",
        "code": "%"
      }
    }
  ]
}
Example Response: 
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 20 Aug 2019 21:17:04 GMT
Etag: W/"12809861"
Last-Modified: TTue, 20 Aug 2019 21:17:04 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
Back to Top