NAV Navbar
Logo cerner
Ruby Shell

Observation API v1

The HealtheIntent Observation API allows systems to interact with observations data in HealtheIntent.

Notes:

URL: https://cernerdemo.api.us.healtheintent.com/observation/v1

Observation

Observations are measurements and simple name-value pair assertions about a patient, for example, lab results, vital signs, and personal characteristics such as eye color. Additionally, observations can originate from procedures, physical exams, or devices that measure activity without the supervision of a provider, for example, fitness devices that measure steps.

Retrieve a Single Observation

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations/d2a0e887-3c11-3c92-b14d-5007fa6501cc', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations/d2a0e887-3c11-3c92-b14d-5007fa6501cc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "aliases": [
    {
      "system": "http://hl7.org/fhir/observation-category",
      "value": "vital-signs"
    }
  ],
  "code": {
    "codings": [
      {
        "system": "2.16.840.1.113883.6.1",
        "code": "46418-0",
        "display": "INR in Capillary blood by Coagulation assay"
      },
      {
        "system": "D1EF6DD8A18C429E9A95C77A5439956D",
        "code": "PT_INR_OBSTYPE",
        "display": "PT INR"
      }
    ],
    "sourceCodings": [
      {
        "code": "1676",
        "display": "INR FINGERSTICK",
        "system": "allscripts:resulttype"
      }
    ],
    "text": "INR FINGERSTICK"
  },
  "device": [
    {
      "manufacturer": "QUALCOMM",
      "model": "Fora Thermometer IR20b",
      "serialNumber": "xyz123",
      "type": {
        "codings": {
          "code": "27991004",
          "display": "Thermometer",
          "system": "2.16.840.1.113883.6.9"
        },
        "sourceCodings": {
          "code": "27991004",
          "display": "Thermometer",
          "system": "2.16.840.1.113883.6.96"
        },
        "text": "Thermometer"
      }
    }
  ],
  "effectiveDate": "2011-07-26T20:53:00.000Z",
  "effectivePeriod": {},
  "encounter": {
    "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
  },
  "id": "d2a0e887-3c11-3c92-b14d-5007fa6501cc",
  "interpretation": {
    "codings": [
      {
        "code": "N",
        "display": "Normal",
        "system": "2.16.840.1.113883.12.78"
      }
    ],
    "sourceCodings": [
      {
        "code": "214",
        "system": "urn:cerner:coding:codingsystem:codeset:52"
      }
    ],
    "text": "Normal"
  },
  "issuedOn": "2011-07-26T21:10:00.000Z",
  "method": {
    "codings": [
      {
        "code": "89003005",
        "display": "Oral temperature taking (procedure)",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "89003005",
        "display": "Oral temperature taking (procedure)",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Oral temperature taking (procedure)"
  },
  "notes": [
    {
      "author": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.814",
            "type": "DEA",
            "value": "1234"
          }
        ],
        "name": {
          "formatted": "Brizendine, Margaret"
        }
      },
      "date": "2011-07-27T01:06:40.310Z",
      "text": "The patient is feeling well today.",
      "type": {
        "codings": [
          {
            "code": "74",
            "display": "Result Comments",
            "system": "urn:cerner:coding:codingsystem:codeset:14"
          }
        ],
        "sourceCodings": [
          {
            "code": "281296001",
            "display": "Result Comments",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Result Comments"
      }
    }
  ],
  "ontologicalCategory": {
    "codings": [
      {
        "code": "laboratory",
        "system": "2.16.840.1.113883.4.642.1.1125"
      }
    ],
    "sourceCodings": []
  },
  "performers": [
    {
      "function": "ORDER",
      "provider": {
        "aliases": [
          {
            "type": "DEA"
          }
        ],
        "name": {
          "prefix": "Dr.",
          "given": [
            "Jane",
            "Susannah"
          ],
          "family": [
            "Smith"
          ],
          "suffix": "MD.",
          "formatted": "Dr. Jane Susannah Smith MD."
        }
      }
    }
  ],
  "provenances": [
    {
      "entities": [
        {
          "role": {
            "sourceCodings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "codings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "text": "Source"
          },
          "what": {
            "documentReference": {
              "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
            }
          }
        }
      ],
      "agents": [
        {
          "type": {
            "sourceCodings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "codings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "text": "Author"
          },
          "who": {
            "organization": {
              "name": "Rockcreek Clinic",
              "aliases": [
                {
                  "value": "151579",
                  "type": "EXTERNAL",
                  "system": "1.2.3.4.5.6.7.8.9.10.1"
                }
              ]
            }
          }
        }
      ],
      "recordedOn": "2011-07-26T23:53:00.000Z"
    }
  ],
  "recorder": "PROVIDER",
  "referenceRange": {
    "display": "36.1-37.2 degree C",
    "low": {
      "numericValue": {
        "value": "36.0",
        "modifier": ">"
      }
    },
    "high": {
      "numericValue": {
        "value": "37.3",
        "modifier": "<"
      }
    }
  },
  "requester": {
    "aliases": [
      {
        "type": "DEA"
      }
    ],
    "name": {
      "prefix": "Dr.",
      "given": [
        "Jane",
        "Susannah"
      ],
      "family": [
        "Smith"
      ],
      "suffix": "MD.",
      "formatted": "Dr. Jane Susannah Smith MD."
    }
  },
  "sourceIdentifier": {
    "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
    "id": "F585DD3407BB4409CBB971F9B8DD3C6F"
  },
  "specimen": {
    "bodySite": {
      "codings": {
        "code": "10740-9",
        "display": "Aluminum.microscopic observation [Identifier] in Bone by Histomorphometry stain",
        "system": "2.16.840.1.113883.6.1"
      },
      "sourceCodings": {
        "code": "10740-9",
        "display": "Right Arm",
        "system": "2.16.840.1.113883.6.1"
      },
      "text": "Right Arm"
    },
    "collectedOn": "2019-05-10",
    "receivedOn": "2019-05-10",
    "type": {
      "codings": {
        "code": "66746-9",
        "display": "Blood",
        "system": "2.16.840.1.113883.6.1"
      },
      "sourceCodings": {
        "code": "66746-9",
        "display": "Specimen Type",
        "system": "2.16.840.1.113883.6.1"
      },
      "text": "Blood"
    }
  },
  "specimenType": {
    "codings": [
      {}
    ],
    "sourceCodings": [
      {}
    ]
  },
  "status": {
    "codings": [
      {
        "code": "F",
        "display": "Final results",
        "system": "2.16.840.1.113883.12.85"
      }
    ],
    "sourceCodings": [
      {
        "code": "25",
        "display": "Auth (Verified)",
        "system": "urn:cerner:coding:codingsystem:codeset:8"
      }
    ],
    "text": "Auth"
  },
  "value": {
    "codified": [],
    "numeric": {
      "modifier": "<",
      "value": "100"
    },
    "unitOfMeasure": {
      "codings": [
        {
          "code": "258710007",
          "display": "degrees C",
          "system": "2.16.840.1.113883.6.96"
        }
      ],
      "sourceCodings": [
        {
          "code": "252",
          "display": "DegC",
          "system": "urn:cerner:coding:codingsystem:codeset:54"
        }
      ],
      "text": "degrees C"
    }
  }
}

GET /populations/{populationId}/patients/{patientId}/observations/{observationId}

Retrieves a single observation for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The ID of the patient. -
populationId path string true N/A The ID of the population. -
observationId path string true N/A The unique ID of the observation record. -

Response Statuses

Status Meaning Description Schema
200 OK OK Observation
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Retrieve a List of Observations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "aliases": [
        {
          "system": "http://hl7.org/fhir/observation-category",
          "value": "vital-signs"
        }
      ],
      "code": {
        "codings": [
          {
            "system": "2.16.840.1.113883.6.1",
            "code": "46418-0",
            "display": "INR in Capillary blood by Coagulation assay"
          },
          {
            "system": "D1EF6DD8A18C429E9A95C77A5439956D",
            "code": "PT_INR_OBSTYPE",
            "display": "PT INR"
          }
        ],
        "sourceCodings": [
          {
            "code": "1676",
            "display": "INR FINGERSTICK",
            "system": "allscripts:resulttype"
          }
        ],
        "text": "INR FINGERSTICK"
      },
      "device": [
        {
          "manufacturer": "QUALCOMM",
          "model": "Fora Thermometer IR20b",
          "serialNumber": "xyz123",
          "type": {
            "codings": {
              "code": "27991004",
              "display": "Thermometer",
              "system": "2.16.840.1.113883.6.9"
            },
            "sourceCodings": {
              "code": "27991004",
              "display": "Thermometer",
              "system": "2.16.840.1.113883.6.96"
            },
            "text": "Thermometer"
          }
        }
      ],
      "effectiveDate": "2011-07-26T20:53:00.000Z",
      "effectivePeriod": {},
      "encounter": {
        "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
      },
      "id": "d2a0e887-3c11-3c92-b14d-5007fa6501cc",
      "interpretation": {
        "codings": [
          {
            "code": "N",
            "display": "Normal",
            "system": "2.16.840.1.113883.12.78"
          }
        ],
        "sourceCodings": [
          {
            "code": "214",
            "system": "urn:cerner:coding:codingsystem:codeset:52"
          }
        ],
        "text": "Normal"
      },
      "issuedOn": "2011-07-26T21:10:00.000Z",
      "method": {
        "codings": [
          {
            "code": "89003005",
            "display": "Oral temperature taking (procedure)",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "89003005",
            "display": "Oral temperature taking (procedure)",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Oral temperature taking (procedure)"
      },
      "notes": [
        {
          "author": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.814",
                "type": "DEA",
                "value": "1234"
              }
            ],
            "name": {
              "formatted": "Brizendine, Margaret"
            }
          },
          "date": "2011-07-27T01:06:40.310Z",
          "text": "The patient is feeling well today.",
          "type": {
            "codings": [
              {
                "code": "74",
                "display": "Result Comments",
                "system": "urn:cerner:coding:codingsystem:codeset:14"
              }
            ],
            "sourceCodings": [
              {
                "code": "281296001",
                "display": "Result Comments",
                "system": "2.16.840.1.113883.6.96"
              }
            ],
            "text": "Result Comments"
          }
        }
      ],
      "ontologicalCategory": {
        "codings": [
          {
            "code": "laboratory",
            "system": "2.16.840.1.113883.4.642.1.1125"
          }
        ],
        "sourceCodings": []
      },
      "performers": [
        {
          "function": "ORDER",
          "provider": {
            "aliases": [
              {
                "type": "DEA"
              }
            ],
            "name": {
              "prefix": "Dr.",
              "given": [
                "Jane",
                "Susannah"
              ],
              "family": [
                "Smith"
              ],
              "suffix": "MD.",
              "formatted": "Dr. Jane Susannah Smith MD."
            }
          }
        }
      ],
      "provenances": [
        {
          "entities": [
            {
              "role": {
                "sourceCodings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "codings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "text": "Source"
              },
              "what": {
                "documentReference": {
                  "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
                }
              }
            }
          ],
          "agents": [
            {
              "type": {
                "sourceCodings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "codings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "text": "Author"
              },
              "who": {
                "organization": {
                  "name": "Rockcreek Clinic",
                  "aliases": [
                    {
                      "value": "151579",
                      "type": "EXTERNAL",
                      "system": "1.2.3.4.5.6.7.8.9.10.1"
                    }
                  ]
                }
              }
            }
          ],
          "recordedOn": "2011-07-26T23:53:00.000Z"
        }
      ],
      "recorder": "PROVIDER",
      "referenceRange": {
        "display": "36.1-37.2 degree C",
        "low": {
          "numericValue": {
            "value": "36.0",
            "modifier": ">"
          }
        },
        "high": {
          "numericValue": {
            "value": "37.3",
            "modifier": "<"
          }
        }
      },
      "requester": {
        "aliases": [
          {
            "type": "DEA"
          }
        ],
        "name": {
          "prefix": "Dr.",
          "given": [
            "Jane",
            "Susannah"
          ],
          "family": [
            "Smith"
          ],
          "suffix": "MD.",
          "formatted": "Dr. Jane Susannah Smith MD."
        }
      },
      "sourceIdentifier": {
        "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
        "id": "F585DD3407BB4409CBB971F9B8DD3C6F"
      },
      "specimen": {
        "bodySite": {
          "codings": {
            "code": "10740-9",
            "display": "Aluminum.microscopic observation [Identifier] in Bone by Histomorphometry stain",
            "system": "2.16.840.1.113883.6.1"
          },
          "sourceCodings": {
            "code": "10740-9",
            "display": "Right Arm",
            "system": "2.16.840.1.113883.6.1"
          },
          "text": "Right Arm"
        },
        "collectedOn": "2019-05-10",
        "receivedOn": "2019-05-10",
        "type": {
          "codings": {
            "code": "66746-9",
            "display": "Blood",
            "system": "2.16.840.1.113883.6.1"
          },
          "sourceCodings": {
            "code": "66746-9",
            "display": "Specimen Type",
            "system": "2.16.840.1.113883.6.1"
          },
          "text": "Blood"
        }
      },
      "specimenType": {
        "codings": [
          {}
        ],
        "sourceCodings": [
          {}
        ]
      },
      "status": {
        "codings": [
          {
            "code": "F",
            "display": "Final results",
            "system": "2.16.840.1.113883.12.85"
          }
        ],
        "sourceCodings": [
          {
            "code": "25",
            "display": "Auth (Verified)",
            "system": "urn:cerner:coding:codingsystem:codeset:8"
          }
        ],
        "text": "Auth"
      },
      "value": {
        "codified": [],
        "numeric": {
          "modifier": "<",
          "value": "100"
        },
        "unitOfMeasure": {
          "codings": [
            {
              "code": "258710007",
              "display": "degrees C",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "252",
              "display": "DegC",
              "system": "urn:cerner:coding:codingsystem:codeset:54"
            }
          ],
          "text": "degrees C"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/observation/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2e3ce8f-5ee0-482b-99e2-21de1824f8a2/observations?offset=0&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/observations

Retrieves a list of the observations for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
patientId path string true N/A The ID of the patient. -
populationId path string true N/A The ID of the population. -
category query array[string] false N/A Filters the list based on ontological category codes -
observationId query array[string] false N/A The unique ID of the observation record. -

Response Statuses

Status Meaning Description Schema
200 OK OK Observations
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Schema Definitions

Observation

Name Type Required Description Accepted Values
accession string false An ID that can be used to group laboratory results and also uniquely identifies the specimen used. -
aliases [Alias] true A list of unique IDs to identify an observation in a given system. -
code CodeableConcept true The name of the test or kind of observation that was measured or observed. For example, height, eye color, tobacco use, or hemoglobin level. The code may optionally have additional precoordinated information, such as the method, sample type, timing of measurement, and scale of measurement. -
device Device false The device that recorded, measured, or transmitted the observation or measurement. For example, a glucometer, blood pressure cuff, scale, thermometer, or fitness or sleep devices. -
effectiveDate string false The clinically significant date and time associated with the observation. For laboratory results, this is the specimen collection time; for vitals, this is the time the measurement was taken. In _ISO_8601 (International Organization for Standardization) formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
effectivePeriod Period false The clinically significant time period associated with the observation when the measurement is made over a period of time. For example, distance walked, calories burned, or REM (rapid eye movement) sleep. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
encounter Encounter false The encounter associated with the observation. -
id string true The unique ID of the observation record. -
interpretation CodeableConcept false A categorization of the measurement value that indicates normalcy. For example, abnormal, normal, high, low, or critical. -
issuedOn string false The date and time when the results were made available to providers. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
method CodeableConcept false The means or technique used to make the observation. The method can be precoordinated in the observation code. For example, if the observation code is LOINC 60978-4 Heart Rate Intra Arterial Line Invasive, the code indicates what is being measured and what measuring method is used. By contrast, if the observation code is simply LOINC 8867-4 Heart Rate, then a method of palpation, auscultation, electrocardiogram (ECG or EKG), or invasive provides additional context regarding how the heart rate was measured. -
notes [ProviderNote] true The notes or comments associated with the observation. -
ontologicalCategory CodeableConcept false The ontological categorization of the observation derived from the observation code or kind of observation, such as laboratory or vital signs. -
performers [Performer] true A list of the ordering and administering performers associated with an observation. -
provenances [Provenance] true The record-keeping assertions about the context in which the information in this observation was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source Consolidated Clinical Document Architecture (C-CDA) document from which this observation was derived, if applicable). -
recorder string false Identifies the entity that is reporting the observation. For example, SELF or DEVICE. If the data source does not differentiate or maintain the recorder for each observation, the data source may send the least common denominator across all observations. For example, if a data source has observations from a DEVICE as well as SELF, due to the patient entering data through a personal device dashboard, then all observations from that data source may have a recorder of SELF. DEVICE, PROVIDER, SELF, UNKNOWN
referenceRange ReferenceRange false The reference range associated with the observation. -
requester Provider false The provider who ordered or requested the service that resulted in this observation. -
sourceIdentifier SourceIdentifier false An ID that uniquely identifies this observation for a patient in a data partition. -
specimen Specimen false The substance used for analysis. -
specimenType CodeableConcept false The kind of substance used in the analysis, such as blood or urine. -
status CodeableConcept false The state of the observation, such as preliminary, final, amended, or canceled. -
value ObservationValue false The result of the observation or measurement. The data type of the result value is either numeric, codified, text, or a date. -

Alias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Device

Name Type Required Description Accepted Values
manufacturer string false The name of the organization that was responsible for making or producing the device. -
model string false The model identifier assigned by the manufacturer for the device. This may be a product name or a series of identifying characters. -
serialNumber string false A number or group of numbers and letters that uniquely identifies an individual device. -
type CodeableConcept true The kind of device, such as glucometer, blood pressure cuff, scale, or thermometer. -

Period

Name Type Required Description Accepted Values
end string false The date when the measurement period ended. If start exists without end, then this indicates that the period is ongoing. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
start string false The date when the measurement period started. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

Encounter

Name Type Required Description Accepted Values
id string false The unique ID of the encounter. -

ProviderNote

Name Type Required Description Accepted Values
date string false The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author Provider false The individual who recorded the note or comment. -
type CodeableConcept false The type of the note or comment. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

Performer

Name Type Required Description Accepted Values
function string false Indicates the type of performance (for example, ordering provider, administering provider, and so on). PERFORM, AUTHENTICATE, ORDER
provider Provider false The provider who performed the observation. -

Provenance

Name Type Required Description Accepted Values
entities [ProvenanceEntity] true A list of entities used in this activity. -
agents [ProvenanceAgent] true Actors taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. -
recordedOn string false When the activity was recorded/updated. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

ProvenanceEntity

Name Type Required Description Accepted Values
role CodeableConcept false How the entity was used in a provenance activity (for example, source). -
what ProvenanceEntityIdentity false Identity of the entity used in the provenance activity. -

ProvenanceEntityIdentity

Name Type Required Description Accepted Values
documentReference DocumentReferenceId false The ID of the document reference entity used in the provenance activity. -

DocumentReferenceId

Name Type Required Description Accepted Values
id string false The unique ID that identifies the document reference within the data partition to which it was published. -

ProvenanceAgent

Name Type Required Description Accepted Values
type CodeableConcept true The participation the agent had with respect to the activity. -
who ProvenanceAgentEntity false Who participated as an agent in a provenance activity. -

ProvenanceAgentEntity

Name Type Required Description Accepted Values
organization Organization false An organization participating entity. -

Organization

Name Type Required Description Accepted Values
name string false The name of the organization. -
aliases [OrganizationAlias] true A list of IDs of the organization, such as the NPI or the tax ID. -

OrganizationAlias

Name Type Required Description Accepted Values
value string true The unique ID of the alias. -
type string true The type of organization alias, such as NPI. NPI, TAX, EXTERNAL, NABP, HL7_OID
system string false The authority responsible for assigning the alias value. Alias values may be unique within this system namespace but not across systems. -

ReferenceRange

Name Type Required Description Accepted Values
display string false The textual value for the reference range. -
low Quantity false The value of the low bound of the reference range. -
high Quantity false The value of the high bound of the reference range. -

Quantity

Name Type Required Description Accepted Values
numericValue NumericValue false Indicates that the reference range is a numeric value. -
textValue TextValue false Text-based reference range in an observation, which may be used when a quantitative range is not appropriate for an observation. -

NumericValue

Name Type Required Description Accepted Values
modifier string false A comparator that indicates how to interpret the numeric value, for example, >, <, >=, or <=. Often present due to limitations in measurement precision. -
value string true The low or high reference range value, expressed as a numeric value that can be a positive or negative whole number or decimal value. -

TextValue

Name Type Required Description Accepted Values
value string false The reference range value, expressed as a text value. -

SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string false An ID that uniquely identifies this entity for a patient in the data partition. -

Specimen

Name Type Required Description Accepted Values
bodySite CodeableConcept false The body site where the specimen was collected. -
collectedOn string false The date that the specimen was collected. -
receivedOn string false The date that the specimen was received in the laboratory. -
type CodeableConcept false The type of substance used in the analysis, such as blood or urine. -

ObservationValue

Name Type Required Description Accepted Values
codified [CodifiedValue] true The result of the observation or measurement expressed using one or more codified values. -
date string false The result of the observation or measurement expressed using a date. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
numeric NumericValue false The result of the observation or measurement expressed using a numeric value. -
text string false The result of the observation or measurement expressed using text. -
unitOfMeasure CodeableConcept false The unit of measure for the observation. -

CodifiedValue

Name Type Required Description Accepted Values
sequence string false Indicates the sequence, order, or priority of the codified values when an observation has multiple codified values. -
value CodeableConcept true The value of the codified observation. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Observations

Name Type Required Description Accepted Values
items [Observation] true [Retrieves a single observation for a given patient.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -