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 2025-09-24 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="CaremeshResourceFind"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition CaremeshResourceFind</b></p><a name="CaremeshResourceFind"> </a><a name="hcCaremeshResourceFind"> </a><a name="CaremeshResourceFind-en-US"> </a><p>URL: [base]/Practitioner/$find</p><p>URL: [base]/HealthcareService/$find</p><p>URL: [base]/Organization/$find</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>identifier</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Unique identifiers of the resource (applicable to Practitioner, HealthcareService, Organization).</p>
</div></td></tr><tr><td>IN</td><td>name</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Name of the HealthcareService or Organization. Not used for Practitioner (use given/family instead).</p>
</div></td></tr><tr><td>IN</td><td>given</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>First (given) name of the Practitioner. Applicable to Practitioner only.</p>
</div></td></tr><tr><td>IN</td><td>family</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Last (family) name of the Practitioner. Applicable to Practitioner only.</p>
</div></td></tr><tr><td>IN</td><td>middle</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Middle name or initial of the Practitioner. Applicable to Practitioner only.</p>
</div></td></tr><tr><td>IN</td><td>suffix</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Name suffix (e.g., MD, DR) for the Practitioner. Applicable to Practitioner only.</p>
</div></td></tr><tr><td>IN</td><td>address-city</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>City component of the resource's address (Practitioner, HealthcareService, Organization).</p>
</div></td></tr><tr><td>IN</td><td>address-state</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>State component of the resource's address (Practitioner, HealthcareService, Organization).</p>
</div></td></tr><tr><td>IN</td><td>address-zip</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Postal code (ZIP) component of the resource's address (Practitioner, HealthcareService, Organization).</p>
</div></td></tr><tr><td>IN</td><td>address-line</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Street line(s) of the resource's address (Practitioner, HealthcareService, Organization).</p>
</div></td></tr><tr><td>IN</td><td>telecom</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Telecom entries (e.g., phone number, direct address, email) for the resource.</p>
</div></td></tr><tr><td>IN</td><td>phone</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Phone numbers for the resource.</p>
</div></td></tr><tr><td>IN</td><td>email</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Email addresses for the resource.</p>
</div></td></tr><tr><td>IN</td><td>specialty</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Practitioner or HealthcareService specialties. Not applicable to Organization.</p>
</div></td></tr></table></div>
</text>
<url
value="http://fhir.caremesh.app/OperationDefinition/CaremeshResourceFind"/>
<version value="0.1.0"/>
<name value="careMESH Find $find"/>
<title value="Find Practitioner / HealthcareService / Organization"/>
<status value="active"/>
<kind value="operation"/>
<date value="2025-09-24"/>
<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 search for Practitioners, HealthcareServices, or Organizations.
General:
- This operation may be invoked on the Practitioner, HealthcareService, or Organization resource types (see examples below).
- Different resource types accept different subsets of the query parameters described below.
Resource-specific notes and examples:
- Practitioner: supports given, family, middle, suffix, address components, telecom, phone, email, specialty, identifier.
Example:
GET /4_0_0/Practitioner/$find?given=Jane&family=Doe&specialty=207R00000X&specialty=207KA0200X
- HealthcareService: uses name instead of given/family, does not use middle or suffix; supports address components, telecom, phone, email, specialty, identifier.
Example:
GET /4_0_0/HealthcareService/$find?name=Mount+Sinai&specialty=207R00000X
- Organization: uses name only; supports address components, telecom, phone, email, identifier; does NOT support specialty.
Example:
GET /4_0_0/Organization/$find?name=Lenox+Hill&telecom=2124342000
Notes:
- Multiple values for a parameter are provided by repeating the query parameter (e.g., specialty=207R00000X&specialty=207KA0200X).
- Resource search is done using identifier, name, and address information. Additionally information is used to further match and improve scoring."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<code value="find"/>
<resource value="Practitioner"/>
<resource value="HealthcareService"/>
<resource value="Organization"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="identifier"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Unique identifiers of the resource (applicable to Practitioner, HealthcareService, Organization)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="name"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Name of the HealthcareService or Organization. Not used for Practitioner (use given/family instead)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="given"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="First (given) name of the Practitioner. Applicable to Practitioner only."/>
<type value="string"/>
</parameter>
<parameter>
<name value="family"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Last (family) name of the Practitioner. Applicable to Practitioner only."/>
<type value="string"/>
</parameter>
<parameter>
<name value="middle"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Middle name or initial of the Practitioner. Applicable to Practitioner only."/>
<type value="string"/>
</parameter>
<parameter>
<name value="suffix"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Name suffix (e.g., MD, DR) for the Practitioner. Applicable to Practitioner only."/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-city"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="City component of the resource's address (Practitioner, HealthcareService, Organization)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-state"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="State component of the resource's address (Practitioner, HealthcareService, Organization)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-zip"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Postal code (ZIP) component of the resource's address (Practitioner, HealthcareService, Organization)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-line"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Street line(s) of the resource's address (Practitioner, HealthcareService, Organization)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="telecom"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Telecom entries (e.g., phone number, direct address, email) for the resource."/>
<type value="string"/>
</parameter>
<parameter>
<name value="phone"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="Phone numbers for the resource."/>
<type value="string"/>
</parameter>
<parameter>
<name value="email"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="Email addresses for the resource."/>
<type value="string"/>
</parameter>
<parameter>
<name value="specialty"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Practitioner or HealthcareService specialties. Not applicable to Organization."/>
<type value="string"/>
</parameter>
</OperationDefinition>