careMESH NPD
0.1.0 - ci-build
careMESH NPD
0.1.0 - ci-build
careMESH NPD - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2021-07-29 |
{
"resourceType" : "OperationDefinition",
"id" : "caremesh-export",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition caremesh-export</b></p><a name=\"caremesh-export\"> </a><a name=\"hccaremesh-export\"> </a><a name=\"caremesh-export-en-US\"> </a><p>URL: [base]/Patient/$export</p><p>URL: [base]/Organization/$export</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>_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>\n<p>The format for the requested Bulk Data files to be generated as\nper <a href=\"http://hl7.org/fhir/R4/async.html\">FHIR Asynchronous Request Pattern</a>.\nDefaults to <code>application/fhir+ndjson</code>. The server SHALL support <a href=\"http://ndjson.org\">Newline\nDelimited JSON</a>, but MAY choose to support additional output\nformats. The server SHALL accept the full content type of <code>application/fhir+ndjson</code>\nas well as the abbreviated representations <code>application/ndjson</code> and <code>ndjson</code>.</p>\n</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>\n<p>Resources will be included in the response if their state has changed\nafter the supplied time (e.g., if <code>Resource.meta.lastUpdated</code> is\nlater than the supplied <code>_since</code> time). The server MAY return\nresources that are referenced by the resources being returned regardless\nof when the referenced resources were last updated. For resources\nwhere the server does not maintain a last updated time, the server\nMAY include these resources in a response irrespective of the\n<code>_since</code> value supplied by a client.</p>\n</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\nFHIR resource types.</p>\n<p>The response SHALL be filtered to only include resources of the specified\nresource types(s).</p>\n<p>If this parameter is omitted, the server SHALL return all supported\nresources within the scope of the client authorization, though implementations\nMAY limit the resources returned to specific subsets of FHIR, such as\nthose defined in the <a href=\"http://www.hl7.org/fhir/us/core/\">US Core Implementation Guide</a>.</p>\n<p>A server that is unable to support <code>_type</code> SHOULD return an error and FHIR\n<code>OperationOutcome</code> resource so the client can re-submit a request omitting the\n<code>_type</code> parameter. If the client explicitly asks for export of resources that\nthe Bulk Data server doesn't support, or asks for only resource types that\nare outside the Resource Compartment, the server SHOULD return details via a\nFHIR <code>OperationOutcome</code> resource in an error response to the request.\nWhen a <code>Prefer: handling=lenient</code> header is included in the request,\nthe server MAY process the request instead of returning an error.</p>\n<p>For example <code>_type=Observation</code> could be used to filter a given export\nresponse to return only FHIR <code>Observation</code> resources.</p>\n</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>\n<p>When provided, the server SHOULD omit unlisted, non-mandatory elements from the\nresources returned. Elements SHOULD be of the form <code>[resource type].[element name]</code></p>\n<p>(e.g., <code>Resource.id</code>) or <code>[element name]</code> (e.g., <code>id</code>) and only root elements in\na resource are permitted. If the resource type is omitted, the element SHOULD be\nreturned for all resources in the response where it is applicable.</p>\n<p>A server is not obliged to return just the requested elements. A server SHOULD\nalways return mandatory elements whether they are requested or not. A server\nSHOULD mark the resources with the tag <code>SUBSETTED</code> to ensure that the\nincomplete resource is not actually used to overwrite a complete resource.</p>\n<p>A server that is unable to support <code>_elements</code> SHOULD return an error\nand a FHIR <code>OperationOutcome</code> resource so the client can re-submit a request\nomitting the <code>_elements</code> parameter. When a <code>Prefer: handling=lenient</code> header is\nincluded in the request, the server MAY process the request instead of\nreturning an error.</p>\n</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> (<a href=\"http://hl7.org/fhir/R4/resource.html\" title=\"http://hl7.org/fhir/StructureDefinition/Resource\">Resource</a>)</td><td/><td><div><p>This parameter is only valid in kickoff requests initiated through a HTTP POST request.\nWhen provided, the server SHALL NOT return resources in the Resource compartments\nbelonging to Resources outside of this list. If a client requests Resources who are\nnot present on the server or are not members of the requested group, the server SHOULD\nreturn details via a FHIR <code>OperationOutcome</code> resource in an error response to the\nrequest.</p>\n<p>A server that is unable to support the <code>Resource</code> parameter SHOULD return an error\nand FHIR <code>OperationOutcome</code> resource so the client can re-submit a request omitting\nthe <code>Resource</code> parameter. When a <code>Prefer: handling=lenient</code> header is included in\nthe request, the server MAY process the request instead of returning an\nerror.</p>\n</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>\n<p>When provided, a server with support for the parameter and requested values SHALL\nreturn or omit a pre-defined set of FHIR resources associated with the request.</p>\n<p>A server that is unable to support the requested <code>includeAssociatedData</code> values SHOULD\nreturn an error and a FHIR <code>OperationOutcome</code> resource so the client can re-submit\na request that omits those values (for example, if a server does not retain provenance\ndata). When a <code>Prefer: handling=lenient</code> header is included in the request, the server\nMAY process the request instead of returning an error.</p>\n<p>If multiple conflicting values are included, the server SHALL apply the least restrictive\nvalue (value that will return the largest dataset).</p>\n</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>\n<p>When provided, a server with support for the parameter and requested search queries\nSHALL filter the data in the response to only include resources that meet the specified\ncriteria. FHIR search response parameters such as <code>_include</code> and <code>_sort</code> SHALL NOT\nbe used.</p>\n<p>A server that that is unable to support the requested <code>_typeFilter</code> queries SHOULD\nreturn an error and a FHIR <code>OperationOutcome</code> resource so the client can re-submit\na request that omits those queries. When a <code>Prefer: handling=lenient</code> header is included\nin the request, the server MAY process the request instead of returning an error.</p>\n</div></td></tr></table></div>"
},
"url" : "http://fhir.caremesh.app/OperationDefinition/caremesh-export",
"version" : "0.1.0",
"name" : "ResourceTypeLevelExport",
"title" : "FHIR Bulk Data ResourceType Level Export",
"status" : "active",
"kind" : "operation",
"date" : "2021-07-29",
"publisher" : "careMESH, Inc.",
"contact" : [
{
"name" : "careMESH, Inc.",
"telecom" : [
{
"system" : "url",
"value" : "http://caremesh.com/"
},
{
"system" : "email",
"value" : "operations@caremesh.com"
}
]
}
],
"description" : "FHIR Operation to obtain a detailed set of FHIR resources of diverse\nresource types pertaining to all Resources. The FHIR server SHALL support invocation\nof this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"code" : "export",
"resource" : [
"Patient",
"Organization"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "_outputFormat",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Support is required for a server, optional for a client.\n\nThe format for the requested Bulk Data files to be generated as \nper [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html). \nDefaults to `application/fhir+ndjson`. The server SHALL support [Newline \nDelimited JSON](http://ndjson.org), but MAY choose to support additional output\nformats. The server SHALL accept the full content type of `application/fhir+ndjson` \nas well as the abbreviated representations `application/ndjson` and `ndjson`.",
"type" : "string"
},
{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Support is required for a server, optional for a client.\n\nResources will be included in the response if their state has changed\nafter the supplied time (e.g., if `Resource.meta.lastUpdated` is \nlater than the supplied `_since` time). The server MAY return \nresources that are referenced by the resources being returned regardless \nof when the referenced resources were last updated. For resources \nwhere the server does not maintain a last updated time, the server \nMAY include these resources in a response irrespective of the \n`_since` value supplied by a client.",
"type" : "instant"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Support is optional for a server and a client. A string of comma-delimited \nFHIR resource types.\n\nThe response SHALL be filtered to only include resources of the specified \nresource types(s).\n\nIf this parameter is omitted, the server SHALL return all supported \nresources within the scope of the client authorization, though implementations \nMAY limit the resources returned to specific subsets of FHIR, such as \nthose defined in the [US Core Implementation Guide](http://www.hl7.org/fhir/us/core/).\n\n\nA server that is unable to support `_type` SHOULD return an error and FHIR \n`OperationOutcome` resource so the client can re-submit a request omitting the \n`_type` parameter. If the client explicitly asks for export of resources that \nthe Bulk Data server doesn't support, or asks for only resource types that \nare outside the Resource Compartment, the server SHOULD return details via a\nFHIR `OperationOutcome` resource in an error response to the request. \nWhen a `Prefer: handling=lenient` header is included in the request, \nthe server MAY process the request instead of returning an error.\n\nFor example `_type=Observation` could be used to filter a given export\nresponse to return only FHIR `Observation` resources.",
"type" : "string"
},
{
"name" : "_elements",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "String of comma-delimited FHIR Elements.\n\nWhen provided, the server SHOULD omit unlisted, non-mandatory elements from the \nresources returned. Elements SHOULD be of the form `[resource type].[element name]`\n\n(e.g., `Resource.id`) or `[element name]` (e.g., `id`) and only root elements in\na resource are permitted. If the resource type is omitted, the element SHOULD be \nreturned for all resources in the response where it is applicable. \n\nA server is not obliged to return just the requested elements. A server SHOULD \nalways return mandatory elements whether they are requested or not. A server \nSHOULD mark the resources with the tag `SUBSETTED` to ensure that the \nincomplete resource is not actually used to overwrite a complete resource.\n\nA server that is unable to support `_elements` SHOULD return an error \nand a FHIR `OperationOutcome` resource so the client can re-submit a request \nomitting the `_elements` parameter. When a `Prefer: handling=lenient` header is \nincluded in the request, the server MAY process the request instead of \nreturning an error.",
"type" : "string"
},
{
"name" : "Resource",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "This parameter is only valid in kickoff requests initiated through a HTTP POST request.\nWhen provided, the server SHALL NOT return resources in the Resource compartments\nbelonging to Resources outside of this list. If a client requests Resources who are\nnot present on the server or are not members of the requested group, the server SHOULD\nreturn details via a FHIR `OperationOutcome` resource in an error response to the\nrequest.\n\nA server that is unable to support the `Resource` parameter SHOULD return an error\nand FHIR `OperationOutcome` resource so the client can re-submit a request omitting\nthe `Resource` parameter. When a `Prefer: handling=lenient` header is included in\nthe request, the server MAY process the request instead of returning an\nerror.",
"type" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Resource"
]
},
{
"name" : "includeAssociatedData",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "String of comma-delimited values.\n\nWhen provided, a server with support for the parameter and requested values SHALL\nreturn or omit a pre-defined set of FHIR resources associated with the request.\n\nA server that is unable to support the requested `includeAssociatedData` values SHOULD\nreturn an error and a FHIR `OperationOutcome` resource so the client can re-submit\na request that omits those values (for example, if a server does not retain provenance\ndata). When a `Prefer: handling=lenient` header is included in the request, the server\nMAY process the request instead of returning an error.\n\nIf multiple conflicting values are included, the server SHALL apply the least restrictive\nvalue (value that will return the largest dataset).",
"type" : "code",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data"
}
},
{
"name" : "_typeFilter",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "String of comma separated FHIR REST search queries.\n\nWhen provided, a server with support for the parameter and requested search queries\nSHALL filter the data in the response to only include resources that meet the specified\ncriteria. FHIR search response parameters such as `_include` and `_sort` SHALL NOT\nbe used. \n\nA server that that is unable to support the requested `_typeFilter` queries SHOULD\nreturn an error and a FHIR `OperationOutcome` resource so the client can re-submit\na request that omits those queries. When a `Prefer: handling=lenient` header is included\nin the request, the server MAY process the request instead of returning an error.",
"type" : "string"
}
]
}