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 2023-02-06 |
{
"resourceType" : "OperationDefinition",
"id" : "caremesh-system-everything",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/$everything</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>type1-npi</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A type 1 NPI to process. May be used in combination with\nthe type2-npi parameter to get all common resources between\nthe designated Practitioner and the designated Organization.</p>\n</div></td></tr><tr><td>IN</td><td>type2-npi</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A type 2 NPI to process. May be used in combination with\nthe type2-npi parameter to get all common resources between\nthe designated Practitioner and the designated Organization.</p>\n</div></td></tr><tr><td>IN</td><td>_summary</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>The default response to the $everything system level\ncall is a FHIR bundle containing all the necessary resources\nreturned.</p>\n<p>If _summary is specified and set to <code>npiDump</code> a Bundle will\nbe returned as the following:</p>\n<pre><code> {\n // a list of locations for the requested type 1 NPI in an\n // abbreviated format. Will be omitted for type 2.\n "_practiceLocations": [{...}],\n // a list of known hospital affiliations for the requested type 1 \n // NPI (will be omitted for type 2)\n "_hospitalAffiliations": [{...}],\n // a list of organizations associated with the specified type 1 \n // or type 2 NPI\n "_organizations": [{...}],\n // a list of practitioners associated with the specified type 1 \n // or type 2 NPI\n "_practitioners": [{...}],\n // a list of places where the organization associated with the type 2\n // npi offers services, irrespective of whether any requested \n // practitioner offers services at those locations.\n "_organizationServiceLocations": [{...}],\n\n }\n</code></pre>\n</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A comma separated list of FHIR resource types to include in the result.\nIf not included, defaults to all resource types available.</p>\n</div></td></tr></table></div>"
},
"url" : "http://fhir.caremesh.app/OperationDefinition/caremesh-system-everything",
"version" : "0.1.0",
"name" : "careMESH System Level Everything",
"title" : "System level export for related sets of resources",
"status" : "active",
"kind" : "operation",
"date" : "2023-02-06",
"publisher" : "careMESH, Inc.",
"contact" : [
{
"name" : "careMESH, Inc.",
"telecom" : [
{
"system" : "url",
"value" : "http://caremesh.com/"
},
{
"system" : "email",
"value" : "operations@caremesh.com"
}
]
}
],
"description" : "FHIR Operation to return all resources related to either a type 1 (individual) \nor type 2 (organization) NPI, from the system level.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"code" : "everything",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "type1-npi",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A type 1 NPI to process. May be used in combination with \nthe type2-npi parameter to get all common resources between\nthe designated Practitioner and the designated Organization.",
"type" : "string"
},
{
"name" : "type2-npi",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A type 2 NPI to process. May be used in combination with \nthe type2-npi parameter to get all common resources between\nthe designated Practitioner and the designated Organization.",
"type" : "string"
},
{
"name" : "_summary",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The default response to the $everything system level\ncall is a FHIR bundle containing all the necessary resources \nreturned. \n\nIf _summary is specified and set to `npiDump` a Bundle will \nbe returned as the following:\n\n```\n {\n // a list of locations for the requested type 1 NPI in an\n // abbreviated format. Will be omitted for type 2.\n \"_practiceLocations\": [{...}],\n // a list of known hospital affiliations for the requested type 1 \n // NPI (will be omitted for type 2)\n \"_hospitalAffiliations\": [{...}],\n // a list of organizations associated with the specified type 1 \n // or type 2 NPI\n \"_organizations\": [{...}],\n // a list of practitioners associated with the specified type 1 \n // or type 2 NPI\n \"_practitioners\": [{...}],\n // a list of places where the organization associated with the type 2\n // npi offers services, irrespective of whether any requested \n // practitioner offers services at those locations.\n \"_organizationServiceLocations\": [{...}],\n\n }\n```\n",
"type" : "boolean"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A comma separated list of FHIR resource types to include in the result.\nIf not included, defaults to all resource types available.",
"type" : "string"
}
]
}