...
POST $search-measurement request body:
Parameters available:
Amount | Parameter Name | Type |
---|---|---|
0..1 |
| Reference (Patient |
...
) | ||
0..1 |
| Reference (EpisodeOfCare |
...
) | ||
0..1 |
| Reference (Device |
...
) | ||
1..1 |
| Period |
0..* |
...
| Reference (ServiceRequests) |
Combinations allow for:
broad searches (Patient and Period only)
very specific searches (Period and ServiceRequest) and other combinations
Response:
The response is a bundle of nested bundles that each contain a full set of related resources (Observation, Media, QuestionnaireResponse and Provenance) for a found measurement. If a QuestionnaireResponse is part of a bundle the Questionnaire it answers is also included in the bundle. Related resources are the set of resources created by a single invocation of the submit-measurement operation.
Bundle of:
Bundle for each submitted together:
0..* Observation
0..* Media
0..* QuestionnaireResponse
1..* Questionnaire
0..* Provenance indicating reuse of measurement
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Below example is from here: http://ehealth-documentation.s3-website-eu-west-1.amazonaws.com/latest/ig/POST_search-measurements.html#post-search-measurements Unlike a regular search operation which would be a GET request, the $search-measurement is a POST request to the URL:
The search parameters are sent by including them in the request body (below is a JSON example of a body):
The response will then contain a bundle of bundles with the found resources (Below is a JSON example of a return bundle):
|
Searching for Observation
Possible search parameters:
Name | Description |
---|---|
| the tag of a resource |
| The ID of the resource |
| Search the contents of the resource's narrative using a fulltext search |
| Episode associated with observation |
| Reference to the serviceRequest |
| The unique id for a particular observation |
| The patient that the observation is about |
| The serviceRequestVersionID held in the Resolved Timing |
| Resolved Timing start |
| Resolved Timing end |
| Resolved Timing type |
| The subject that the observation is about |
| The code of the observation type |
| Obtained date/time. If the obtained element is a period, a date that falls in the period |
| The quality code of the observation |
| The quality type of the observation |
Response:
Bundle of
Observation(s)
Expand | ||
---|---|---|
| ||
Searching on Observations are done by use of a traditional GET request:
As an example one could perform searches like the following examples:
An example of a response on for a search could be:
|
Searching on Media
Possible search parameters:
Name | Description |
---|---|
| the tag of a resource |
| The ID of the resource |
| The unique id for a particular observation |
| Episode associated with observation |
| The subject that the observation is about |
| The type of the Media ("photo | video | audio") |
| When Media was collected |
| The quality code of the Media |
| The quality type of the Media |
| ServiceRequest that caused this media to be created |
| The serviceRequestVersionID held in the Resolved Timing |
| Resolved Timing start |
| Resolved Timing end |
| Resolved Timing type |
Response:
Bundle of
Media(s)
Expand | ||
---|---|---|
| ||
Searching on Medias are done by use of a traditional GET request:
As an example one could perform searches like the following examples:
An example of a response on for a search could be:
|
Searching for QuestionnaireResponse
Possible search parameters:
Name | Description |
---|---|
| the tag of a resource |
| The ID of the resource |
| The unique id for a particular observation |
| The status of the QuestionnaireResponse |
| Episode associated with observation |
| The questionnaire the answers are provided for |
| The subject that the observation is about |
| When the questionnaire response was last changed |
| The quality code of the Media |
| The quality type of the Media |
| ServiceRequest that this QuestionnaireResponse is related to |
| The serviceRequestVersionID held in the Resolved Timing |
| Resolved Timing start |
| Resolved Timing end |
| Resolved Timing type |
Response:
Bundle of
QuestionnaireResponse(s)
Expand | ||
---|---|---|
| ||
Searching on QuestionnaireResponses are done by use of a traditional GET request:
As an example one could perform searches like the following examples:
An example of a response on for a search could be:
|