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