This page is part of the US Core (v2.1.0: STU3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Vital Signs Quick Start

Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Mandatory Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHALL be supported. the modifiers, comparators, chains and composites that are listed as optional SHOULD be supported.:

1. SHALL support searching using the combination of the patient and category search parameters:

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

   Example:

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

   Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and a category code = vital-signs (how to search by reference and how to search by token)

2. SHALL support searching using the combination of the patient and code search parameters:
   • including optional support for composite OR search on code (e.g.code={[system]}|[code],{[system]}|[code],...)

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

   Example:

   1. GET [base]/Observation?patient=1186747&code=http://loinc.org|8867-4,http://loinc.org|9279-1,http://loinc.org|85354-9

   Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple codes. The Observation code parameter searches `Observation.code only. (how to search by reference and how to search by token)

3. SHALL support searching using the combination of the patient and category and date search parameters:
   • including support for these date comparators: gt,lt,ge,le
   • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/Observation?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

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

   Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = vital-signs (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHOULD be supported.

1. SHOULD support searching using the combination of the patient and category and status search parameters:

   GET [base]/Observation?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs&status={[system]}|[code]

   Example:

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

   Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)

2. SHOULD support searching using the combination of the patient and code and date search parameters:

   • including optional support for composite OR search on code (e.g.code={[system]}|[code],{[system]}|[code],...)
   • including support for these date comparators: gt,lt,ge,le
   • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

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

   Example:

   1. GET [base]/Observation?patient=1186747&code=http://loinc.org|8867-4,http://loinc.org|9279-1,http://loinc.org|85354-9&date=ge2019

   Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple codes. (how to search by reference and how to search by token and how to search by date)