Overview
Representing a patient’s smoking behavior through the core FHIR Observation Resource. The profile restricts observation code to be set in 72166-2 Tobacco smoking status NHIS (LOINC). Each Observation has next elements:- a status
- a category code of ‘social-history’
- a code for smoking observation
- a patient
- a date representing when the smoking status was recorded
- a result value code for smoking status
| USCore Data Element | FHIR Resource Field |
|---|---|
| status | Observation.status |
| code | Observation.code |
| patient | Observation.subject |
| smoking status recorded date | Observation.effective |
| value | Observation.value |
Must support elements, mandatory and optional search parameters
Observationmust support these elements:statusSlices for categorycategory:SocialHistory
codesubjecteffectiveDateTimevalueCodeableConcept
- including optional support for OR search on code (e.g.code={system|}
[code],{system|}[code])
GET [base url]/Observation?patient={Type/}[id]&code=http://loinc.org|72166-2
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
Observation By Patient Id
Search for Observation by patient. METHOD GET[base url] - FHIR base url
[id] - Id for the Patient HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | No route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn’t know how to handle |
Observation By Id
Get Observation by ID. METHOD GET[base url] - FHIR base url
{id} - Id for Observation resource
HEADERS
The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | No route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn’t know how to handle |
Observation by patient and code
Get Observations for the specified patient and code search parameters METHOD GET[base url] - FHIR base url
[id] - patient id
{Type/} - Type for the Reference. Example: Patient
HEADERS
The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | No route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn’t know how to handle |