Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
| Draft as of 2020-05-27 |
{
"resourceType" : "OperationDefinition",
"id" : "unique",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition unique</b></p><a name=\"unique\"> </a><a name=\"hcunique\"> </a><a name=\"unique-en-US\"> </a><p>URL: [base]/Patient/$null</p><p>URL: [base]/Patient/[id]/$null</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>birthdate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The birthdate of this patient [required]</p>\n</div></td></tr><tr><td>IN</td><td>family</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The last name of this patient [required]</p>\n</div></td></tr><tr><td>IN</td><td>gender</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The gender of this patient [required]</p>\n</div></td></tr><tr><td>IN</td><td>given</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The first or middle name for this patient [required]</p>\n</div></td></tr><tr><td>IN</td><td>address-postalcode</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 zip code of the patient [optional]</p>\n</div></td></tr><tr><td>IN</td><td>email</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The email address for this patient [optional]</p>\n</div></td></tr><tr><td>IN</td><td>identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Any other identifier known for this patient [optional]</p>\n</div></td></tr><tr><td>IN</td><td>phone</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>A phone number for this patient [optional]</p>\n</div></td></tr><tr><td>IN</td><td>telecom</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>A phone number or email address for this patient [optional]</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/patient.html\">Patient</a></td><td/><td><div><p>The patient that was found.</p>\n</div></td></tr></table></div>"
},
"url" : "http://somewhere.org/fhir/uv/myig/OperationDefinition/unique",
"version" : "23.1.0",
"name" : "Find Unique Patient",
"status" : "draft",
"kind" : "operation",
"date" : "2020-05-27T01:06:56+05:30",
"publisher" : "athenahealth",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://athenahealth.com"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm"
}
]
}
],
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "birthdate",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The birthdate of this patient [required]",
"type" : "date"
},
{
"name" : "family",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The last name of this patient [required]",
"type" : "string"
},
{
"name" : "gender",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The gender of this patient [required]",
"type" : "string",
"searchType" : "token"
},
{
"name" : "given",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The first or middle name for this patient [required]",
"type" : "string"
},
{
"name" : "address-postalcode",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The zip code of the patient [optional]",
"type" : "string"
},
{
"name" : "email",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The email address for this patient [optional]",
"type" : "string",
"searchType" : "token"
},
{
"name" : "identifier",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Any other identifier known for this patient [optional]",
"type" : "string",
"searchType" : "token"
},
{
"name" : "phone",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A phone number for this patient [optional]",
"type" : "string",
"searchType" : "token"
},
{
"name" : "telecom",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A phone number or email address for this patient [optional]",
"type" : "string",
"searchType" : "token"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The patient that was found.",
"type" : "Patient"
}
]
}