Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-04-17 |
{
"resourceType" : "OperationDefinition",
"id" : "ah-patient-match",
"meta" : {
"source" : "athenacoreext"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ah-patient-match</b></p><a name=\"ah-patient-match\"> </a><a name=\"hcah-patient-match\"> </a><a name=\"ah-patient-match-en-US\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Information Source: <a href=\"https://simplifier.net/resolve?scope=ig-athena-core@dev&canonical=https://fhir.athena.io/core/athenacoreext\">athenacoreext</a></p></div><p>URL: [base]/Patient/$match</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>resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).</p>\n</div></td></tr><tr><td>IN</td><td>onlyCertainMatches</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly.</p>\n</div></td></tr><tr><td>IN</td><td>count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned.</p>\n</div></td></tr><tr><td>IN</td><td>x-useCase</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The athenahealth Patient match use case (Scheduling | CareQuality | HDPE).</p>\n</div></td></tr><tr><td>IN</td><td>x-targetSource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>This can be used to specify target source from which patient records are retrieved</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>A Bundle containing a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)</p>\n</div></td></tr></table></div>"
},
"url" : "https://fhir.athena.io/OperationDefinition/ah-patient-match",
"version" : "4.2.0",
"name" : "AthenahealthPatientMatch",
"title" : "athenahealth Patient Match",
"status" : "active",
"kind" : "operation",
"date" : "2025-04-17T16:42:09+00:00",
"publisher" : "athenahealth",
"contact" : [
{
"name" : "FHIR Enablement Team",
"telecom" : [
{
"system" : "email",
"value" : "mailto:fhir-enablement@athenahealth.com"
}
]
}
],
"description" : "An extension to the base Patient-match OperationDefinition adding two additional optional input parameters to further classify the specific Patient match criteria.",
"code" : "match",
"base" : "http://hl7.org/fhir/OperationDefinition/Patient-match",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).",
"type" : "Resource"
},
{
"name" : "onlyCertainMatches",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly.",
"type" : "boolean"
},
{
"name" : "count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned.",
"type" : "integer"
},
{
"name" : "x-useCase",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The athenahealth Patient match use case (Scheduling | CareQuality | HDPE).",
"type" : "string"
},
{
"name" : "x-targetSource",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "This can be used to specify target source from which patient records are retrieved",
"type" : "uri"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A Bundle containing a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)",
"type" : "Bundle"
}
]
}