Observation $write-vitals

post/Observation/$write-vitals
Page View

This resource comprises one or more results, findings, or measurements to inform a patient’s clinical condition (e.g., vitals, imaging results, lab results, device measurements). Observations can help to identify baselines and patterns or define personal characteristics for a patient (e.g., height, weight, eye color). Observations may be referenced by a DiagnosticReport resource to provide the metadata for a complete diagnostic report.  

You can receive, retrieve, or save observations for a patient. 

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.

$write-vitals

This operation allows you to save one or more vital signs to a patient’s chart.

Request parameters and payload

Select example

cURL request example

cURL
curl 'https://api.redoxengine.com/fhir/R4/{destinationId}/{environmentFlag}/Observation/$write-vitals' \
--request POST \
--header 'Authorization: Bearer $API_TOKEN' \
--header 'Content-Type: application/fhir+json' \
--data '{
  "resourceType": "Bundle",
  "id": "RedoxVitalSignsBloodPressureObservationExampleTimothy",
  "type": "message",
  "timestamp": "2021-12-17T20:33:22.422Z",
  "entry": [
    {
      "resource": {
        "resourceType": "MessageHeader",
        "id": "RedoxMessageHeaderExample",
        "source": {
          "name": "Good Health Clinics",
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
        },
        "eventCoding": {
          "system": "urn:redox:event-type",
          "code": "Observation-New"
        }
      }
    },
    {
      "resource": {
        "resourceType": "Patient",
        "id": "RedoxPatientExampleTimothyMinimal",
        "identifier": [
          {
            "value": "0000000001",
            "system": "urn:redox:health-one:MR"
          },
          {
            "value": "101-01-0001",
            "system": "http://hl7.org/fhir/sid/us-ssn"
          }
        ],
        "name": [
          {
            "given": [
              "Timothy",
              "Paul"
            ],
            "family": "Bixby"
          }
        ],
        "gender": "male",
        "birthDate": "2008-01-06"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "id": "RedoxBloodPressureObservationExample",
        "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"
            }
          ],
          "text": "Blood pressure systolic & diastolic"
        },
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8480-6"
                }
              ]
            },
            "valueQuantity": {
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]",
              "value": 132,
              "unit": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "code": "N",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "display": "Normal"
                  }
                ]
              }
            ]
          },
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8462-4"
                }
              ]
            },
            "valueQuantity": {
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]",
              "value": 82,
              "unit": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "code": "N",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "display": "Normal"
                  }
                ]
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
            "value": "1893025234"
          }
        ],
        "subject": {
          "reference": "Patient/RedoxPatientExampleTimothy"
        },
        "status": "final",
        "effectiveDateTime": "1999-11-14T00:00:00.000Z",
        "note": [
          {
            "text": "Blood pressure measurement performed"
          }
        ],
        "performer": [
          {
            "reference": "Practitioner/RedoxPractitionerExamplePat"
          }
        ],
        "referenceRange": [
          {
            "low": {
              "value": 110,
              "unit": "mm[Hg]"
            },
            "high": {
              "value": 160,
              "unit": "mm[Hg]"
            },
            "text": "Blood pressure range"
          }
        ]
      }
    }
  ]
}'

Request Body Schema

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of MessageHeader, Patient, Observation or Other

    An array of FHIR resources. At a minimum, a Vital Signs Observation should include the following entries:

    • Patient - the patient
    • Observation - the vital signs observation

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          Value: Observation-New
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

"Operation Response"