eHealth Infrastructure
3.2.0 - release
eHealth Infrastructure
3.2.0 - release
This page is part of the FUT Infrastructure (v3.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2024-09-02 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="-s-search-measurements-bundle-limit"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition -s-search-measurements-bundle-limit</b></p><a name="-s-search-measurements-bundle-limit"> </a><a name="hc-s-search-measurements-bundle-limit"> </a><a name="-s-search-measurements-bundle-limit-en-US"> </a><p>URL: [base]/$search-measurements-bundle-limit</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>Find resource(s) referring the specified patient - Reference(eHealth Patient).</p>
</div></td></tr><tr><td>IN</td><td>episodeOfCare</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).</p>
</div></td></tr><tr><td>IN</td><td>count</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>The number of bundles to return, max allowed value is 100 - Integer.</p>
</div></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.</p>
</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.</p>
</div></td></tr><tr><td>IN</td><td>based-on</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).</p>
</div></td></tr><tr><td>IN</td><td>_tag</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td/><td><div><p>Search for resources which have the given tag.</p>
</div></td></tr><tr><td>OUT</td><td>bundle</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td/></tr></table></div>
</text>
<url
value="https://measurement.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-search-measurements-bundle-limit"/>
<version value="3.2.0"/>
<name value="search-measurements-bundle-limit"/>
<title value="Search measurements bundle limit"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-09-02T14:02:47+00:00"/>
<publisher
value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
<contact>
<name value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
<telecom>
<system value="url"/>
<value value="http://ehealth.sundhed.dk"/>
</telecom>
</contact>
<description
value="The search-measurements-bundle-limit operation searches for a number of bundles of related resources having Observations, Media or QuestionnaireResponses matching the search criteria.
### Parameter description
- patient: Find resource(s) referring the specified patient - Reference(eHealth Patient).
- episodeOfCare: Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare).
- count: The number of bundles to return, max allowed value is 100 - Integer.
- start: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime.
- end: Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime.
- based-on: Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest).
- _tag: When specified, resource(s) must have at least one of the specified tags in meta data - for instance a Coding(ehealth-system CodeSystem) or on token form: http://ehealth.sundhed.dk/cs/ehealth-system|xa. Note that the _tag functions as an optional filter, not as a selection criteria in the way the other parameters work.
One of either "start" or "end", along with the "count" parameter must always be specified.
Additionally at least "patient" or "episodeOfCare" or "serviceRequest" must be specified.
### Output description
The result of this operation returns a Bundle with a list of nested Bundles having resources matching the search parameters. The number of nested Bundles depends on the count parameter.
Each of the nested bundles contains the full set of related eHealth Observation, eHealth Media, eHealth QuestionnaireResponse and eHealth Provenance resources, from the same submission request.
Related resources are the set of resources created by a single invocation of the submit-measurement operation.
"/>
<affectsState value="false"/>
<code value="search-measurements-bundle-limit"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="patient"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Find resource(s) referring the specified patient - Reference(eHealth Patient)."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="episodeOfCare"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Find resource(s) referring the specified episode of care - Reference(eHealth EpisodeOfCare)."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="count"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The number of bundles to return, max allowed value is 100 - Integer."/>
<type value="integer"/>
</parameter>
<parameter>
<name value="start"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted after this time. The result bundles will be sorted in ascending order - DateTime."/>
<type value="dateTime"/>
</parameter>
<parameter>
<name value="end"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Based on submitted time / Provenance.recorded. If provided, the operation will search for resource(s) submitted before this time. The result bundles will be sorted in descending order - DateTime."/>
<type value="dateTime"/>
</parameter>
<parameter>
<name value="based-on"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Resources(s) must be based on any of the specified service requests - Reference(eHealth ServiceRequest)."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="_tag"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="Search for resources which have the given tag."/>
<type value="Coding"/>
</parameter>
<parameter>
<name value="bundle"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.2.0 based on FHIR 4.0.1. Generated 2024-09-02
