This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Profile for query
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="query-definitions.html#Query" title="A description of a query with a set of parameters."><b>Query</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="query-definitions.html#Query.identifier" title="Links query and its response(s)."><b>identifier</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Links query and its response(s)</span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.parameter" title="Set of query parameters with values."><b>parameter</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">Set of query parameters with values</span><span style="color: Gray"> --></span></parameter> <<a class="dict" href="query-definitions.html#Query.response" title="If this is a response to a query."><b>response</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> If this is a response to a query --></span> <<a class="dict" href="query-definitions.html#Query.response.identifier" title="Links response to source query."><b>identifier</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Links response to source query</span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.response.outcome" title="Outcome of processing the query."><b>outcome</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="query-outcome.html" style="color: navy">ok | limited | refused | error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.response.total" title="Total number of matching records."><b>total</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Total number of matching records</span><span style="color: Gray"> --></span> <<a class="dict" href="query-definitions.html#Query.response.parameter" title="Parameters server used."><b>parameter</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">Parameters server used</span><span style="color: Gray"> --></span></parameter> <<a class="dict" href="query-definitions.html#Query.response.first" title="To get first page (if paged)."><b>first</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">To get first page (if paged)</span><span style="color: Gray"> --></span></first> <<a class="dict" href="query-definitions.html#Query.response.previous" title="To get previous page (if paged)."><b>previous</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">To get previous page (if paged)</span><span style="color: Gray"> --></span></previous> <<a class="dict" href="query-definitions.html#Query.response.next" title="To get next page (if paged)."><b>next</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">To get next page (if paged)</span><span style="color: Gray"> --></span></next> <<a class="dict" href="query-definitions.html#Query.response.last" title="To get last page (if paged)."><b>last</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="extensibility.html#Extension">Extension</a></span> <span style="color: navy">To get last page (if paged)</span><span style="color: Gray"> --></span></last> <<a class="dict" href="query-definitions.html#Query.response.reference" title="Resources that are the results of the search."><b>reference</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="resourcelist.html">Any</a>)</span> <span style="color: navy">Resources that are the results of the search</span><span style="color: Gray"> --></span></reference> </response> </Query> </pre></div> </text> <name value="query"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A description of a query with a set of parameters."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage The resource is used to perform queries using messaging-based exchanges, and to perform asynchronous searches using the RESTful interface."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <structure> <type value="Query"/> <publish value="true"/> <element> <path value="Query"/> <definition> <short value="A description of a query with a set of parameters"/> <formal value="A description of a query with a set of parameters."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="QuerySpec"/> </mapping> </definition> </element> <element> <path value="Query.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.identifier"/> <definition> <short value="Links query and its response(s)"/> <formal value="Links query and its response(s)."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".queryId"/> </mapping> </definition> </element> <element> <path value="Query.parameter"/> <definition> <short value="Set of query parameters with values"/> <formal value="Set of query parameters with values."/> <comments value="Unless otherwise specified, parameters are usually strings."/> <min value="1"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".parameter"/> </mapping> </definition> </element> <element> <path value="Query.response"/> <definition> <short value="If this is a response to a query"/> <formal value="If this is a response to a query."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="QueryAck (indirectly linked through .queryId, directly linked via Message.acknowledges"/> </mapping> </definition> </element> <element> <path value="Query.response.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.response.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Query.response.identifier"/> <definition> <short value="Links response to source query"/> <formal value="Links response to source query."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".queryId?"/> </mapping> </definition> </element> <element> <path value="Query.response.outcome"/> <definition> <short value="ok | limited | refused | error"/> <formal value="Outcome of processing the query."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="QueryOutcome"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/query-outcome"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value=".queryResponseCode"/> </mapping> </definition> </element> <element> <path value="Query.response.total"/> <definition> <short value="Total number of matching records"/> <formal value="Total number of matching records."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".resultTotalQuantity"/> </mapping> </definition> </element> <element> <path value="Query.response.parameter"/> <definition> <short value="Parameters server used"/> <formal value="Parameters server used."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.first"/> <definition> <short value="To get first page (if paged)"/> <formal value="To get first page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.previous"/> <definition> <short value="To get previous page (if paged)"/> <formal value="To get previous page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.next"/> <definition> <short value="To get next page (if paged)"/> <formal value="To get next page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".continuationToken"/> </mapping> </definition> </element> <element> <path value="Query.response.last"/> <definition> <short value="To get last page (if paged)"/> <formal value="To get last page (if paged)."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not supported"/> </mapping> </definition> </element> <element> <path value="Query.response.reference"/> <definition> <short value="Resources that are the results of the search"/> <formal value="Resources that are the results of the search."/> <comments value="Is query only used in messaging?."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".controlAct.outboundRelationship[typeCode=SUBJ].target or .controlAct.participation[typeCode=SBJ].ro le"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Links query and its response(s)"/> <xpath value="f:Query/f:identifier"/> </searchParam> <searchParam> <name value="response"/> <type value="token"/> <documentation value="Links response to source query"/> <xpath value="f:Query/f:response/f:identifier"/> </searchParam> </structure> </Profile>
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change