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