caremesh-export - XML Representation

careMESH NPD - Local Development build (v0.1.0). See the Directory of published versions
: caremesh-export - XML Representation

Active as of 2021-07-29


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="caremesh-export"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Patient/$export</p><p>URL: [base]/Organization/$export</p><p>Parameters</p><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>_outputFormat</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Support is required for a server, optional for a client.</p>
<p>The format for the requested Bulk Data files to be generated as
per <a href="http://hl7.org/fhir/R4/async.html">FHIR Asynchronous Request Pattern</a>.
Defaults to <code>application/fhir+ndjson</code>. The server SHALL support <a href="http://ndjson.org">Newline
Delimited JSON</a>, but MAY choose to support additional output
formats. The server SHALL accept the full content type of <code>application/fhir+ndjson</code>
as well as the abbreviated representations <code>application/ndjson</code> and <code>ndjson</code>.</p>
</div></td></tr><tr><td>IN</td><td>_since</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td/><td><div><p>Support is required for a server, optional for a client.</p>
<p>Resources will be included in the response if their state has changed
after the supplied time (e.g., if <code>Resource.meta.lastUpdated</code> is
later than the supplied <code>_since</code> time). The server MAY return
resources that are referenced by the resources being returned regardless
of when the referenced resources were last updated. For resources
where the server does not maintain a last updated time, the server
MAY include these resources in a response irrespective of the
<code>_since</code> value supplied by a client.</p>
</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Support is optional for a server and a client.  A string of comma-delimited
FHIR resource types.</p>
<p>The response SHALL be filtered to only include resources of the specified
resource types(s).</p>
<p>If this parameter is omitted, the server SHALL return all supported
resources within the scope of the client authorization, though implementations
MAY limit the resources returned to specific subsets of FHIR, such as
those defined in the <a href="http://www.hl7.org/fhir/us/core/">US Core Implementation Guide</a>.</p>
<p>A server that is unable to support <code>_type</code> SHOULD return an error and FHIR
<code>OperationOutcome</code> resource so the client can re-submit a request omitting the
<code>_type</code> parameter. If the client explicitly asks for export of resources that
the Bulk Data server doesn't support, or asks for only resource types that
are outside the Resource Compartment, the server SHOULD return details via a
FHIR <code>OperationOutcome</code> resource in an error response to the request.
When a <code>Prefer: handling=lenient</code> header is included in the request,
the server MAY process the request instead of returning an error.</p>
<p>For example <code>_type=Observation</code> could be used to filter a given export
response to return only FHIR <code>Observation</code> resources.</p>
</div></td></tr><tr><td>IN</td><td>_elements</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>String of comma-delimited FHIR Elements.</p>
<p>When provided, the server SHOULD omit unlisted, non-mandatory elements from the
resources returned. Elements SHOULD be of the form <code>[resource type].[element name]</code></p>
<p>(e.g., <code>Resource.id</code>) or <code>[element name]</code> (e.g., <code>id</code>) and only root elements in
a resource are permitted. If the resource type is omitted, the element SHOULD be
returned for all resources in the response where it is applicable.</p>
<p>A server is not obliged to return just the requested elements. A server SHOULD
always return mandatory elements whether they are requested or not. A server
SHOULD mark the resources with the tag <code>SUBSETTED</code> to ensure that the
incomplete resource is not actually used to overwrite a complete resource.</p>
<p>A server that is unable to support <code>_elements</code> SHOULD return an error
and a FHIR <code>OperationOutcome</code> resource so the client can re-submit a request
omitting the <code>_elements</code> parameter. When a <code>Prefer: handling=lenient</code> header is
included in the request, the server MAY process the request instead of
returning an error.</p>
</div></td></tr><tr><td>IN</td><td>Resource</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>This parameter is only valid in kickoff requests initiated through a HTTP POST request.
When provided, the server SHALL NOT return resources in the Resource compartments
belonging to Resources outside of this list. If a client requests Resources who are
not present on the server or are not members of the requested group, the server SHOULD
return details via a FHIR <code>OperationOutcome</code> resource in an error response to the
request.</p>
<p>A server that is unable to support the <code>Resource</code> parameter SHOULD return an error
and FHIR <code>OperationOutcome</code> resource so the client can re-submit a request omitting
the <code>Resource</code> parameter. When a <code>Prefer: handling=lenient</code> header is included in
the request, the server MAY process the request instead of returning an
error.</p>
</div></td></tr><tr><td>IN</td><td>includeAssociatedData</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td>http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data (Extensible)</td><td><div><p>String of comma-delimited values.</p>
<p>When provided, a server with support for the parameter and requested values SHALL
return or omit a pre-defined set of FHIR resources associated with the request.</p>
<p>A server that is unable to support the requested <code>includeAssociatedData</code> values SHOULD
return an error and a FHIR <code>OperationOutcome</code> resource so the client can re-submit
a request that omits those values (for example, if a server does not retain provenance
data). When a <code>Prefer: handling=lenient</code> header is included in the request, the server
MAY process the request instead of returning an error.</p>
<p>If multiple conflicting values are included, the server SHALL apply the least restrictive
value (value that will return the largest dataset).</p>
</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>String of comma separated FHIR REST search queries.</p>
<p>When provided, a server with support for the parameter and requested search queries
SHALL filter the data in the response to only include resources that meet the specified
criteria. FHIR search response parameters such as <code>_include</code> and <code>_sort</code> SHALL NOT
be used.</p>
<p>A server that that is unable to support the requested <code>_typeFilter</code> queries SHOULD
return an error and a FHIR <code>OperationOutcome</code> resource so the client can re-submit
a request that omits those queries. When a <code>Prefer: handling=lenient</code> header is included
in the request, the server MAY process the request instead of returning an error.</p>
</div></td></tr></table></div>
  </text>
  <url value="http://fhir.caremesh.app/OperationDefinition/caremesh-export"/>
  <version value="0.1.0"/>
  <name value="ResourceTypeLevelExport"/>
  <title value="FHIR Bulk Data ResourceType Level Export"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2021-07-29"/>
  <publisher value="careMESH, Inc."/>
  <contact>
    <name value="careMESH, Inc."/>
    <telecom>
      <system value="url"/>
      <value value="http://caremesh.com/"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="operations@caremesh.com"/>
    </telecom>
  </contact>
  <description
               value="FHIR Operation to obtain a detailed set of FHIR resources of diverse
resource types pertaining to all Resources. The FHIR server SHALL support invocation
of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <code value="export"/>
  <resource value="Patient"/>
  <resource value="Organization"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="_outputFormat"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Support is required for a server, optional for a client.

The format for the requested Bulk Data files to be generated as 
per [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html). 
Defaults to `application/fhir+ndjson`. The server SHALL support [Newline 
Delimited JSON](http://ndjson.org), but MAY choose to support additional output
formats. The server SHALL accept the full content type of `application/fhir+ndjson` 
as well as the abbreviated representations `application/ndjson` and `ndjson`."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_since"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Support is required for a server, optional for a client.

Resources will be included in the response if their state has changed
after the supplied time (e.g., if `Resource.meta.lastUpdated` is 
later than the supplied `_since` time). The server MAY return 
resources that are referenced by the resources being returned regardless 
of when the referenced resources were last updated. For resources 
where the server does not maintain a last updated time, the server 
MAY include these resources in a response irrespective of the 
`_since` value supplied by a client."/>
    <type value="instant"/>
  </parameter>
  <parameter>
    <name value="_type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Support is optional for a server and a client.  A string of comma-delimited 
FHIR resource types.

The response SHALL be filtered to only include resources of the specified 
resource types(s).

If this parameter is omitted, the server SHALL return all supported 
resources within the scope of the client authorization, though implementations 
MAY limit the resources returned to specific subsets of FHIR, such as 
those defined in the [US Core Implementation Guide](http://www.hl7.org/fhir/us/core/).


A server that is unable to support `_type` SHOULD return an error and FHIR 
`OperationOutcome` resource so the client can re-submit a request omitting the 
`_type` parameter. If the client explicitly asks for export of resources that 
the Bulk Data server doesn't support, or asks for only resource types that 
are outside the Resource Compartment, the server SHOULD return details via a
FHIR `OperationOutcome` resource in an error response to the request. 
When a `Prefer: handling=lenient` header is included in the request, 
the server MAY process the request instead of returning an error.

For example `_type=Observation` could be used to filter a given export
response to return only FHIR `Observation` resources."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_elements"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="String of comma-delimited FHIR Elements.

When provided, the server SHOULD omit unlisted, non-mandatory elements from the 
resources returned. Elements SHOULD be of the form `[resource type].[element name]`

(e.g., `Resource.id`) or `[element name]` (e.g., `id`) and only root elements in
a resource are permitted. If the resource type is omitted, the element SHOULD be 
returned for all resources in the response where it is applicable. 

A server is not obliged to return just the requested elements. A server SHOULD 
always return mandatory elements whether they are requested or not. A server 
SHOULD mark the resources with the tag `SUBSETTED` to ensure that the 
incomplete resource is not actually used to overwrite a complete resource.

A server that is unable to support `_elements` SHOULD return an error 
and a FHIR `OperationOutcome` resource so the client can re-submit a request 
omitting the `_elements` parameter. When a `Prefer: handling=lenient` header is 
included in the request, the server MAY process the request instead of 
returning an error."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="Resource"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="This parameter is only valid in kickoff requests initiated through a HTTP POST request.
When provided, the server SHALL NOT return resources in the Resource compartments
belonging to Resources outside of this list. If a client requests Resources who are
not present on the server or are not members of the requested group, the server SHOULD
return details via a FHIR `OperationOutcome` resource in an error response to the
request.

A server that is unable to support the `Resource` parameter SHOULD return an error
and FHIR `OperationOutcome` resource so the client can re-submit a request omitting
the `Resource` parameter. When a `Prefer: handling=lenient` header is included in
the request, the server MAY process the request instead of returning an
error."/>
    <type value="Reference"/>
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
  </parameter>
  <parameter>
    <name value="includeAssociatedData"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="String of comma-delimited values.

When provided, a server with support for the parameter and requested values SHALL
return or omit a pre-defined set of FHIR resources associated with the request.

A server that is unable to support the requested `includeAssociatedData` values SHOULD
return an error and a FHIR `OperationOutcome` resource so the client can re-submit
a request that omits those values (for example, if a server does not retain provenance
data). When a `Prefer: handling=lenient` header is included in the request, the server
MAY process the request instead of returning an error.

If multiple conflicting values are included, the server SHALL apply the least restrictive
value (value that will return the largest dataset)."/>
    <type value="code"/>
    <binding>
      <strength value="extensible"/>
      <valueSet
                value="http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data"/>
    </binding>
  </parameter>
  <parameter>
    <name value="_typeFilter"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="String of comma separated FHIR REST search queries.

When provided, a server with support for the parameter and requested search queries
SHALL filter the data in the response to only include resources that meet the specified
criteria. FHIR search response parameters such as `_include` and `_sort` SHALL NOT
be used. 

A server that that is unable to support the requested `_typeFilter` queries SHOULD
return an error and a FHIR `OperationOutcome` resource so the client can re-submit
a request that omits those queries. When a `Prefer: handling=lenient` header is included
in the request, the server MAY process the request instead of returning an error."/>
    <type value="string"/>
  </parameter>
</OperationDefinition>