- Created by Erik Nielsen, last modified by Andreas Harfeld Jakobsen on 17-06-2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Current »
Patient
Patients can search for measurements by:
$search-measurements
Searching measurements with $search-measurements
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
Examples:
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:
POST [base]/$search-measurements
The search parameters are sent by including them in the request body (below is a JSON example of a body):
{ "resourceType": "Parameters", "parameter": [ { "name": "patient", "valueReference": { "reference": "https://patient.cit-measurement-1414.local/fhir/Patient/47556" } }, { "name": "period", "valuePeriod": { "start": "2020-12-21T00:00:00+00:00" } } ] }
The response will then contain a bundle of bundles with the found resources (Below is a JSON example of a return bundle):
{ "resourceType": "Bundle", "type": "collection", "entry": [ { "fullUrl": "f1e15387-6e84-4a5f-ab0d-076b4c6ea906", "resource": { "resourceType": "Bundle", "id": "f1e15387-6e84-4a5f-ab0d-076b4c6ea906", "type": "collection", "entry": [ { "fullUrl": "https://measurement.cit-measurement-1414.local/fhir/Observation/350", "resource": { "resourceType": "Observation", "id": "350", "meta": { "versionId": "1", "lastUpdated": "2021-12-21T14:10:01.692+00:00", "source": "#b2ec62fc-7f07-44", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.cit-measurement-1414.local/fhir/EpisodeOfCare/73880" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.cit-measurement-1414.local/fhir/ServiceRequest/48367" } ], "status": "final", "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "subject": { "reference": "https://patient.cit-measurement-1414.local/fhir/Patient/47556" }, "effectivePeriod": { "start": "2021-12-21T14:10:01+00:00", "end": "2021-12-21T14:10:01+00:00" }, "performer": [ { "reference": "https://patient.cit-measurement-1414.local/fhir/Patient/47556" } ], "device": { "reference": "https://device.cit-measurement-1414.local/fhir/Device/38078" } } }, { "fullUrl": "https://measurement.cit-measurement-1414.local/fhir/Media/351", "resource": { "resourceType": "Media", "id": "351", "meta": { "versionId": "1", "lastUpdated": "2021-12-21T14:10:01.982+00:00", "source": "#38603316-dade-48", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.cit-measurement-1414.local/fhir/EpisodeOfCare/23583" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality", "extension": [ { "url": "qualityType", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/quality-types", "code": "TBD" } ] } }, { "url": "qualityCode", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/usage-quality", "code": "TBD" } ] } } ] }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.cit-measurement-1414.local/fhir/ServiceRequest/13775" } ], "status": "completed", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "audio" } ] }, "subject": { "reference": "https://patient.cit-measurement-1414.local/fhir/Patient/47556" }, "createdDateTime": "2021-12-21T14:10:01+00:00", "content": { "language": "en" } } } ] } } ] }
$search-measurements-bundle-limit
Introduced in 2024.3
Searching measurements with $search-measurements-bundle-limit
POST $search-measurement request body:
Parameters available:
Amount | Parameter Name | Type |
---|---|---|
0..1 |
| Reference (Patient) |
0..1 |
| Reference (EpisodeOfCare) |
0..1 |
| Positive Integer |
0..1 |
| DateTimeType |
0..1 |
| DateTimeType |
0..* |
| Reference (ServiceRequests) |
Combinations allow for:
Only one of the parameters Start or End can be used at a time.
If
start
is used, the firstcount
number of bundles after thestart
time is returned.If
end
is used, the latestcount
number of bundles up to theend
time is returned.
broad searches (Patient and Start or End only)
precise searches (Start or End 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. The amount of nested bundles is limited by the given count parameter.
Bundle of:
Bundle for each submitted together:
0..* Observation
0..* Media
0..* QuestionnaireResponse
0..* Provenance indicating reuse of measurement
Examples:
Below example is from here: http://ehealth-documentation.s3-website-eu-west-1.amazonaws.com/latest/ig/POST_search-measurements.html#post-search-measurements
Like the $search-measurements operation, the $search-measurements-bundle-limit operation is also a POST request to the URL:
POST [base]/$search-measurements-bundle-limit
The search parameters are sent by including them in the request body (below is a JSON example of a body):
{ "resourceType": "Parameters", "parameter": [ { "name": "patient", "valueReference": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } }, { "name": "count", "valueInteger": 10 }, { "name": "end", "valueDateTime": "2024-06-06T04:41:38+02:00" } ] }
The response will then contain a bundle of bundles with the found resources (Below is a JSON example of a return bundle):
{ "resourceType": "Bundle", "type": "collection", "entry": [ { "fullUrl": "f0d826c9-61d3-4406-8d3e-43e0a0c1ebbd", "resource": { "resourceType": "Bundle", "id": "f0d826c9-61d3-4406-8d3e-43e0a0c1ebbd", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/30", "resource": { "resourceType": "Provenance", "id": "30", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/29" } ], "meta": { "source": "#408ec467-6c79-43", "lastUpdated": "2024-06-17T05:41:37.304+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-06-05T07:41:37.286+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/29", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:37+02:00", "start": "2024-06-17T07:41:37+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/72047" }, "id": "29", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/46567" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#6b5ef661-57ea-4a", "lastUpdated": "2024-06-17T05:41:37.174+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/31566" } ] } } ] } }, { "fullUrl": "2666bbd6-1c51-418a-a32c-ac915dfef6a3", "resource": { "resourceType": "Bundle", "id": "2666bbd6-1c51-418a-a32c-ac915dfef6a3", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/28", "resource": { "resourceType": "Provenance", "id": "28", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/27" } ], "meta": { "source": "#eb81403f-d6e4-4c", "lastUpdated": "2024-06-17T05:41:37.063+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-06-03T07:41:36.986+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/27", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:36+02:00", "start": "2024-06-17T07:41:36+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/2050" }, "id": "27", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/65152" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#b7bbebca-a50c-43", "lastUpdated": "2024-06-17T05:41:36.956+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/82641" } ] } } ] } }, { "fullUrl": "b515e3be-13f3-4eed-8067-83743581781f", "resource": { "resourceType": "Bundle", "id": "b515e3be-13f3-4eed-8067-83743581781f", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/26", "resource": { "resourceType": "Provenance", "id": "26", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/25" } ], "meta": { "source": "#b505a71c-28f4-45", "lastUpdated": "2024-06-17T05:41:36.791+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-06-01T07:41:36.772+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/25", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:36+02:00", "start": "2024-06-17T07:41:36+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/48238" }, "id": "25", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/95071" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#589f2ffe-7597-4c", "lastUpdated": "2024-06-17T05:41:36.675+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/44178" } ] } } ] } }, { "fullUrl": "2233f5a6-1d86-436d-9b24-0a1b29082160", "resource": { "resourceType": "Bundle", "id": "2233f5a6-1d86-436d-9b24-0a1b29082160", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/24", "resource": { "resourceType": "Provenance", "id": "24", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/23" } ], "meta": { "source": "#c321fda6-1f04-45", "lastUpdated": "2024-06-17T05:41:36.550+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-05-31T07:41:36.480+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/23", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:36+02:00", "start": "2024-06-17T07:41:36+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/66978" }, "id": "23", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/55315" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#eba350f6-e680-40", "lastUpdated": "2024-06-17T05:41:36.301+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/52820" } ] } } ] } }, { "fullUrl": "3624c79a-1647-4ea3-97ef-9c153a5ea210", "resource": { "resourceType": "Bundle", "id": "3624c79a-1647-4ea3-97ef-9c153a5ea210", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/22", "resource": { "resourceType": "Provenance", "id": "22", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/21" } ], "meta": { "source": "#92e3dc36-5881-46", "lastUpdated": "2024-06-17T05:41:36.180+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-05-30T07:41:36.163+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/21", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:35+02:00", "start": "2024-06-17T07:41:35+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/65032" }, "id": "21", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/72530" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#f0aede18-939d-40", "lastUpdated": "2024-06-17T05:41:36.072+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/4423" } ] } } ] } }, { "fullUrl": "c9afae18-c908-4f2a-a0e7-b9b487195fc4", "resource": { "resourceType": "Bundle", "id": "c9afae18-c908-4f2a-a0e7-b9b487195fc4", "type": "collection", "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Provenance/20", "resource": { "resourceType": "Provenance", "id": "20", "target": [ { "reference": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/19" } ], "meta": { "source": "#9c9c8c39-fe5d-4d", "lastUpdated": "2024-06-17T05:41:35.953+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance" ], "versionId": "1" }, "agent": [ { "who": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } } ], "policy": [ "http://ehealth.sundhed.dk/policy/ehealth/coherent-submitted-measurement" ], "recorded": "2024-05-28T07:41:35.898+02:00" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/19", "resource": { "resourceType": "Observation", "effectivePeriod": { "end": "2024-06-17T07:41:35+02:00", "start": "2024-06-17T07:41:35+02:00" }, "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" } ], "status": "final", "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/34570" }, "id": "19", "extension": [ { "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/5775" }, "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare" }, { "extension": [ { "valueId": "42", "url": "serviceRequestVersionId" }, { "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] }, "url": "type" } ], "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing" } ], "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/8100" }, "meta": { "source": "#a124fe94-2f0d-43", "lastUpdated": "2024-06-17T05:41:35.785+00:00", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ], "versionId": "1" }, "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/35457" } ] } } ] } } ] }
Search on Observation
Searching for Observation
Below is a list of some of the common search parameters. An exhaustive list can be found in implementation guide at http://ehealth-documentation.s3-website-eu-west-1.amazonaws.com/latest/ig/measurement.openapi.json.
Name | Description |
---|---|
| the tag of a resource |
| The ID of the resource |
| The patient that the observation is about |
| The subject that the observation is about |
| The EpisodeOfCare that the Observation is associated with |
| The ServiceRequest that the observation is based on |
| Resolved Timing start |
| Resolved Timing end |
Response:
Bundle of
Observation(s)
Examples:
Searching on Observations are done by use of a traditional GET request:
GET [base]/fhir/Observation?paramName1=param1¶mName2=param2
As an example one could perform searches like the following examples:
Searching by two resource Ids and and a Subject:
GET [base]/fhir/Observation?_id=1,3&subject=https://patient.local.ehealth.sundhed.dk/fhir/Patient/34032
Searching by occurrence date:
GET [base]/fhir/Observation?date=lt2023-01-22&date=gt2022-10-22
(lt=less than, gt=greater than)Searching by resolvedTiming start and end:
GET [base]/fhir/Observation?resolvedTimingEnd=gt2023-05-22T08:37:42+02:00&resolvedTimingStart=gt2023-05-22T08:37:42+02:00
Search by resource tag:
GET [base]/fhir/Observation?_tag=http://ehealth.sundhed.dk/cs/ehealth-system|xa
An example of a response on for a search could be:
{ "resourceType": "Bundle", "id": "38696d91-c2e4-44c4-9745-9101fde22c68", "meta": { "lastUpdated": "2023-05-22T11:38:07.748+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation?_id=1,3&subject=https://patient.local.ehealth.sundhed.dk/fhir/Patient/11464" } ], "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/3", "resource": { "resourceType": "Observation", "id": "3", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T11:38:07.645+00:00", "source": "#681926ed-87a3-45", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/74121" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/68661" } ], "status": "final", "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/11464" }, "effectivePeriod": { "start": "2023-05-22T13:38:07+02:00", "end": "2023-05-22T13:38:07+02:00" }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/11464" } ], "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/41502" } }, "search": { "mode": "match" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Observation/1", "resource": { "resourceType": "Observation", "id": "1", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T11:38:06.857+00:00", "source": "#ad7c2284-3eb3-47", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-observation" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/14633" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/43518" } ], "status": "final", "code": { "coding": [ { "system": "urn:oid:1.2.208.176.2.1", "code": "NPU03011" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/11464" }, "effectivePeriod": { "start": "2023-05-22T13:38:05+02:00", "end": "2023-05-22T13:38:05+02:00" }, "performer": [ { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/11464" } ], "device": { "reference": "https://device.local.ehealth.sundhed.dk/fhir/Device/72749" } }, "search": { "mode": "match" } } ] }
Search on Media
Searching on Media
Below is a list of some of the common search parameters. An exhaustive list can be found in implementation guide at http://ehealth-documentation.s3-website-eu-west-1.amazonaws.com/latest/ig/measurement.openapi.json.
Name | Description |
---|---|
| the tag of a resource |
| The ID of the resource |
| Episode associated with observation |
| The subject that the observation is about |
| The type of the Media ("photo | video | audio") |
| When Media was collected |
| ServiceRequest that caused this media to be created |
Response:
Bundle of
Media(s)
Examples:
Searching on Medias are done by use of a traditional GET request:
GET [base]/fhir/Media?paramName1=param1¶mName2=param2
As an example one could perform searches like the following examples:
Searching based on Media’s type:
GET [base]/fhir/Media?type=audio
Searching based on when the media was created:
GET [base]/fhir/Media?created=lt2023-03-22&created=gt2023-01-22
An example of a response on for a search could be:
{ "resourceType": "Bundle", "id": "b6164483-cb47-475d-9b3d-35b4ddff2178", "meta": { "lastUpdated": "2023-05-22T12:41:19.064+00:00" }, "type": "searchset", "total": 4, "link": [ { "relation": "self", "url": "https://measurement.local.ehealth.sundhed.dk/fhir/Media?_format=json&created=lt2023-01-22&created=gt2022-10-22&subject=https://patient.local.ehealth.sundhed.dk/fhir/Patient/48739" } ], "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Media/14", "resource": { "resourceType": "Media", "id": "14", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T12:41:18.641+00:00", "source": "#7ffe0a24-79cb-4a", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/38702" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality", "extension": [ { "url": "qualityType", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/quality-types", "code": "TBD" } ] } }, { "url": "qualityCode", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/usage-quality", "code": "TBD" } ] } } ] }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/8100" } ], "status": "completed", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "audio" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/48739" }, "createdPeriod": { "start": "2022-09-22T14:41:18+02:00", "end": "2022-12-22T14:41:18+01:00" }, "content": { "language": "en" } }, "search": { "mode": "match" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Media/15", "resource": { "resourceType": "Media", "id": "15", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T12:41:18.749+00:00", "source": "#0f8ec44e-ddee-47", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/27960" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality", "extension": [ { "url": "qualityType", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/quality-types", "code": "TBD" } ] } }, { "url": "qualityCode", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/usage-quality", "code": "TBD" } ] } } ] }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/42867" } ], "status": "completed", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "audio" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/48739" }, "createdPeriod": { "start": "2022-11-22T14:41:18+01:00", "end": "2022-12-22T14:41:18+01:00" }, "content": { "language": "en" } }, "search": { "mode": "match" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Media/13", "resource": { "resourceType": "Media", "id": "13", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T12:41:18.520+00:00", "source": "#c642ec8c-b6bb-4e", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/57058" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality", "extension": [ { "url": "qualityType", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/quality-types", "code": "TBD" } ] } }, { "url": "qualityCode", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/usage-quality", "code": "TBD" } ] } } ] }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/49636" } ], "status": "completed", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "audio" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/48739" }, "createdPeriod": { "start": "2022-12-22T14:41:18+01:00", "end": "2023-02-22T14:41:18+01:00" }, "content": { "language": "en" } }, "search": { "mode": "match" } }, { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/Media/17", "resource": { "resourceType": "Media", "id": "17", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T12:41:18.968+00:00", "source": "#4999c426-89d7-40", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/27864" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality", "extension": [ { "url": "qualityType", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/quality-types", "code": "TBD" } ] } }, { "url": "qualityCode", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/usage-quality", "code": "TBD" } ] } } ] }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/20345" } ], "status": "completed", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "audio" } ] }, "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/48739" }, "createdPeriod": { "start": "2022-09-22T14:41:18+02:00", "end": "2023-02-22T14:41:18+01:00" }, "content": { "language": "en" } }, "search": { "mode": "match" } } ] }
Search on QuestionnaireResponse
Searching for QuestionnaireResponse
Below is a list of some of the common search parameters. An exhaustive list can be found in implementation guide at http://ehealth-documentation.s3-website-eu-west-1.amazonaws.com/latest/ig/measurement.openapi.json.
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 |
Response:
Bundle of
QuestionnaireResponse(s)
Examples:
Searching on QuestionnaireResponses are done by use of a traditional GET request:
GET [base]/fhir/QuestionnaireResponse?paramName1=param1¶mName2=param2
As an example one could perform searches like the following examples:
Searching based on QuestionnaireResponse authored date:
GET [base]/fhir/QuestionnaireResponse?authored=lt2023-03-22&authored=gt2023-01-22
Searching based on the Questionnaire which the QuestionnaireResponse answers:
GET [base]/fhir/QuestionnaireResponse?questionnaire=https://questionnaire.local.ehealth.sundhed.dk/fhir/Questionnaire/16023
Searching on the status of a QuestionnaireResponse:
GET [base]/fhir/QuestionnaireResponse?status=completed
An example of a response on for a search could be:
{ "resourceType": "Bundle", "id": "92503c25-13b5-416b-80ca-c49704bc73cb", "meta": { "lastUpdated": "2023-05-22T12:50:37.166+00:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://measurement.local.ehealth.sundhed.dk/fhir/QuestionnaireResponse?_format=json&authored=lt2023-05-22&authored=gt2023-03-22&based-on=https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/37748&status=completed" } ], "entry": [ { "fullUrl": "https://measurement.local.ehealth.sundhed.dk/fhir/QuestionnaireResponse/28", "resource": { "resourceType": "QuestionnaireResponse", "id": "28", "meta": { "versionId": "1", "lastUpdated": "2023-05-22T12:50:36.849+00:00", "source": "#6cabd658-10e5-4b", "profile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaireresponse" ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare", "valueReference": { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/26793" } }, { "url": "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing", "extension": [ { "url": "serviceRequestVersionId", "valueId": "42" }, { "url": "type", "valueCodeableConcept": { "coding": [ { "system": "http://ehealth.sundhed.dk/cs/resolved-timing-type", "code": "Adhoc" } ] } } ] } ], "basedOn": [ { "reference": "https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/37748" } ], "questionnaire": "https://questionnaire.local.ehealth.sundhed.dk/fhir/Questionnaire/49398", "status": "completed", "subject": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/96689" }, "authored": "2023-04-22T14:50:36+02:00", "source": { "reference": "https://patient.local.ehealth.sundhed.dk/fhir/Patient/25628" } }, "search": { "mode": "match" } } ] }
Practitioner
Practitioners can search for measurements by the same methods as Patients, but restrictions apply:
The practitioner must be logged in using a CareTeam that, in generic terms, ”plays a role in the corresponding EpisodeOfCare or CarePlan”
- No labels