Home
API reference
FHIR® API
FHIR® resources
Observation
$write-vitals

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. 

$write-vitals

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

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Observation/$write-vitals' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxVitalSignsBloodPressureObservationExampleTimothy",
8
  "type": "message",
9
  "timestamp": "2021-12-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventCoding": {
20
          "system": "urn:redox:event-type",
21
          "code": "Observation-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "Patient",
28
        "id": "RedoxPatientExampleTimothyMinimal",
29
        "identifier": [
30
          {
31
            "value": "0000000001",
32
            "system": "urn:redox:health-one:MR"
33
          },
34
          {
35
            "value": "101-01-0001",
36
            "system": "http://hl7.org/fhir/sid/us-ssn"
37
          }
38
        ],
39
        "name": [
40
          {
41
            "given": [
42
              "Timothy",
43
              "Paul"
44
            ],
45
            "family": "Bixby"
46
          }
47
        ],
48
        "gender": "male",
49
        "birthDate": "2008-01-06"
50
      }
51
    },
52
    {
53
      "resource": {
54
        "resourceType": "Observation",
55
        "id": "RedoxBloodPressureObservationExample",
56
        "category": [
57
          {
58
            "coding": [
59
              {
60
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
61
                "code": "vital-signs",
62
                "display": "Vital Signs"
63
              }
64
            ],
65
            "text": "vital-signs"
66
          }
67
        ],
68
        "code": {
69
          "coding": [
70
            {
71
              "system": "http://loinc.org",
72
              "code": "85354-9"
73
            }
74
          ],
75
          "text": "Blood pressure systolic & diastolic"
76
        },
77
        "component": [
78
          {
79
            "code": {
80
              "coding": [
81
                {
82
                  "system": "http://loinc.org",
83
                  "code": "8480-6"
84
                }
85
              ]
86
            },
87
            "valueQuantity": {
88
              "system": "http://unitsofmeasure.org",
89
              "code": "mm[Hg]",
90
              "value": 132,
91
              "unit": "mm[Hg]"
92
            },
93
            "interpretation": [
94
              {
95
                "coding": [
96
                  {
97
                    "code": "N",
98
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
99
                    "display": "Normal"
100
                  }
101
                ]
102
              }
103
            ]
104
          },
105
          {
106
            "code": {
107
              "coding": [
108
                {
109
                  "system": "http://loinc.org",
110
                  "code": "8462-4"
111
                }
112
              ]
113
            },
114
            "valueQuantity": {
115
              "system": "http://unitsofmeasure.org",
116
              "code": "mm[Hg]",
117
              "value": 82,
118
              "unit": "mm[Hg]"
119
            },
120
            "interpretation": [
121
              {
122
                "coding": [
123
                  {
124
                    "code": "N",
125
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
126
                    "display": "Normal"
127
                  }
128
                ]
129
              }
130
            ]
131
          }
132
        ],
133
        "identifier": [
134
          {
135
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
136
            "value": "1893025234"
137
          }
138
        ],
139
        "subject": {
140
          "reference": "Patient/RedoxPatientExampleTimothy"
141
        },
142
        "status": "final",
143
        "effectiveDateTime": "1999-11-14T00:00:00.000Z",
144
        "note": [
145
          {
146
            "text": "Blood pressure measurement performed"
147
          }
148
        ],
149
        "performer": [
150
          {
151
            "reference": "Practitioner/RedoxPractitionerExamplePat"
152
          }
153
        ],
154
        "referenceRange": [
155
          {
156
            "low": {
157
              "value": 110,
158
              "unit": "mm[Hg]"
159
            },
160
            "high": {
161
              "value": 160,
162
              "unit": "mm[Hg]"
163
            },
164
            "text": "Blood pressure range"
165
          }
166
        ]
167
      }
168
    }
169
  ]
170
}'

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

1
"Operation Response"