Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
| Draft as of 2020-05-27 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="unique"/>
<text>
<status value="generated"/>
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
</text>
<url value="http://somewhere.org/fhir/uv/myig/OperationDefinition/unique"/>
<version value="23.1.0"/>
<name value="Find Unique Patient"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2020-05-27T01:06:56+05:30"/>
<publisher value="athenahealth"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://athenahealth.com"/>
</telecom>
</contact>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
</coding>
</jurisdiction>
<resource value="Patient"/>
<system value="false"/>
<type value="true"/>
<instance value="true"/>
<parameter>
<name value="birthdate"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The birthdate of this patient [required]"/>
<type value="date"/>
</parameter>
<parameter>
<name value="family"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The last name of this patient [required]"/>
<type value="string"/>
</parameter>
<parameter>
<name value="gender"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The gender of this patient [required]"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="given"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The first or middle name for this patient [required]"/>
<type value="string"/>
</parameter>
<parameter>
<name value="address-postalcode"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="The zip code of the patient [optional]"/>
<type value="string"/>
</parameter>
<parameter>
<name value="email"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="The email address for this patient [optional]"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Any other identifier known for this patient [optional]"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="phone"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="A phone number for this patient [optional]"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="telecom"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A phone number or email address for this patient [optional]"/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="The patient that was found."/>
<type value="Patient"/>
</parameter>
</OperationDefinition>