API Reference
Start typing to search…

Observation Screening Assessment Information

Overview

The US Core Observation Screening Assessment Profile is based upon the core FHIR Observation Resource and meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Assessments. This profile sets minimum expectations for the Observation resource to record, search, and fetch observations representing screening and assessment results for a patient. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used.

Each Observation Screening Assessment Must Have:

  • a status
  • a category code of "survey"
  • a code describing the type of assessment or screening
  • a patient

Each Observation Screening Assessment Must Support:

  • additional categories that further specify the assessment or screening
  • a time indicating when the survey was taken
  • the answer or a reason why the data is absent
    • if the result value is a numeric quantity and coded quantity units are used, UCUM is required.
  • who answered the questions
  • related questionnaire responses or observations that this observation is made from
  • reference to observations that make up this observation

This resource conforms to USCDI v3 for Assessments - refers to US Core Observation Screening Assessment Profile 6.1.0. Observation Screening Assessment response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.

Must support elements, mandatory and optional search parameters

Observation Screening Assessment must support these elements:

  • status
  • category
    • category:survey
    • category:screening-assessment
  • code
  • subject
  • effective[x]
    • effectiveDateTime
  • performer
  • value[x]
    • valueQuantity
    • valueCodeableConcept
    • valueString
  • dataAbsentReason
  • hasMember
  • derivedFrom

Each Observation Screening Assessment Must Have (Mandatory):

  • status
  • category (with at least one category code of "survey")
  • code
  • subject

The following search parameters and search parameter combinations SHALL be supported:

The syntax used to describe the interactions is described here.

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

  • including support for OR search on category (e.g. category={system|}[code],{system|}[code],...)

GET [base url]/Observation?patient={Type/}[id]&category=survey

SHALL support searching using the combination of the patient and code search parameters:

  • including support for OR search on code (e.g. code={system|}[code],{system|}[code],...)

GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]

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 AND search on date (e.g. date=[date]&date=[date]]&...)

GET [base url]/Observation?patient={Type/}[id]&category=survey&date={gt|lt|ge|le}[date]

The following search parameter combinations SHOULD be supported:

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

  • including support for OR search on category (e.g. category={system|}[code],{system|}[code],...)
  • including support for OR search on status (e.g. status=[code],[code],...)

GET [base url]/Observation?patient={Type/}[id]&category=survey&status={code}

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

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

GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]&date={gt|lt|ge|le}[date]

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

Observation Screening Assessment by Patient and Category

Search for Observation Screening Assessment using combination of patient and category parameters.

METHOD GET

GET [base url]/Observation?patient={Type/}[id]&category=survey

PARAMS [base url] - FHIR base url {Type/} - Reference type for the patient resource. Example: Patient/ [id] - Patient's id

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>

RESPONSES

CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404no Route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=survey' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Observation Screening Assessment by Patient and Code

Search for Observation Screening Assessment using combination of patient and code parameters.

METHOD GET

GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]

PARAMS [base url] - FHIR base url {Type/} - Reference type for the patient resource. Example: Patient/ [id] - Patient's id {system|} - Code system. FHIR search token parameter. See Search specification for more information. Example: http://loinc.org| [code] - Assessment code. Example: 44261-6 (Patient Health Questionnaire 9 item (PHQ-9) total score [Reported])

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>

RESPONSES

CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404no Route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&code=http://loinc.org|44261-6' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Observation Screening Assessment by Patient, Category and Date

Search for Observation Screening Assessment using combination of patient, category, and date parameters.

METHOD GET

GET [base url]/Observation?patient={Type/}[id]&category=survey&date={gt|lt|ge|le}[date]

PARAMS [base url] - FHIR base url {Type/} - Reference type for the patient resource. Example: Patient/ [id] - Patient's id {gt|lt|ge|le} - Date comparator. Example: ge (greater than or equal to) [date] - Date value. Example: 2024-01-01

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>

RESPONSES

CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404no Route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=survey&date=ge2024-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Observation Screening Assessment by Patient, Category and Status

Search for Observation Screening Assessment using combination of patient, category, and status parameters.

METHOD GET

GET [base url]/Observation?patient={Type/}[id]&category=survey&status={code}

PARAMS [base url] - FHIR base url {Type/} - Reference type for the patient resource. Example: Patient/ [id] - Patient's id {code} - Status code. Example: final

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>

RESPONSES

CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404no Route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=survey&status=final' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Observation Screening Assessment by Patient, Code and Date

Search for Observation Screening Assessment using combination of patient, code, and date parameters.

METHOD GET

GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]&date={gt|lt|ge|le}[date]

PARAMS [base url] - FHIR base url {Type/} - Reference type for the patient resource. Example: Patient/ [id] - Patient's id {system|} - Code system. FHIR search token parameter. See Search specification for more information. Example: http://loinc.org| [code] - Assessment code. Example: 44261-6 (Patient Health Questionnaire 9 item (PHQ-9) total score [Reported]) {gt|lt|ge|le} - Date comparator. Example: ge (greater than or equal to) [date] - Date value. Example: 2024-01-01

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>

RESPONSES

CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404no Route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn't know how to handle

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&code=http://loinc.org|44261-6&date=ge2024-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'