Patsiendi üldandmete teenus / Master Patient Index
1.5.0 - trial-use Estonia flag

Patsiendi üldandmete teenus / Master Patient Index - Downloaded Version 1.5.0 See the Directory of published versions

: Patient legal relationships - XML Representation

Active as of 2026-02-13

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="patient-legal-relationship"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition patient-legal-relationship</b></p><a name="patient-legal-relationship"> </a><a name="hcpatient-legal-relationship"> </a><p>URL: [base]/Patient/$legal-relationship</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>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a> (<a href="http://hl7.org/fhir/R5/patient.html" title="http://hl7.org/fhir/StructureDefinition/Patient">Patient</a>)</td><td/><td><div><p>A direct resource reference to the patient resource.</p>
</div></td></tr><tr><td>IN</td><td>relationship-type</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="https://akk.tehik.ee/classifier/fhir/ValueSet/isiku-suhte-tyybid-hl7-ja-snomed">Isiku suhte tüübid HL7 ja SNOMED</a> (Required)</td><td><div><p>Relationship type. If missing, then all relationship types from bound ValueSet are queried.</p>
</div></td></tr><tr><td>IN</td><td>custody-type</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="https://akk.tehik.ee/classifier/fhir/ValueSet/hooldusoiguse-liik">Hooldusõiguse liik</a> (Required)</td><td><div><p>Custody type. If missing, then only personal custody types ('H10', 'H11', 'H12') from bound ValueSet are queried.</p>
</div></td></tr><tr><td>IN</td><td>nocache</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Specifies when the operation should ignore the value stored in the cache and should re-request data from the source. By default <em>false</em>.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/bundle.html">Bundle</a></td><td/><td><div><p>Returns Bundle (with type 'collection') with Observation instances of <a href="StructureDefinition-ee-mpi-socialhistory-legal-relationship.html">EEMPISocialHistoryLegalRelationship</a> profile. If multiple custody types are found between two persons, then multiple Observation instances for the same patient relationship are returned.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://fhir.ee/mpi/OperationDefinition/patient-legal-relationship"/>
  <version value="1.5.0"/>
  <name value="EEMPIPatientLegalRelationship"/>
  <title value="Patient legal relationships"/>
  <status value="active"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2026-02-13T09:07:39+00:00"/>
  <publisher value="TEHIK"/>
  <contact>
    <name value="TEHIK"/>
    <telecom>
      <system value="url"/>
      <value value="https://tehik.ee"/>
    </telecom>
  </contact>
  <description
               value="Operations that returns a list of valid (at the moment of the request) patient legal relationships based on data from Population Register (RR). Returns also custody types where applicable."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="EE"/>
      <display value="Estonia"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="legal-relationship"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="A direct resource reference to the patient resource."/>
    <type value="Reference"/>
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
  </parameter>
  <parameter>
    <name value="relationship-type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Relationship type. If missing, then all relationship types from bound ValueSet are queried."/>
    <type value="code"/>
    <binding>
      <strength value="required"/>
      <valueSet
                value="https://fhir.ee/ValueSet/isiku-suhte-tyybid-hl7-ja-snomed"/>
    </binding>
  </parameter>
  <parameter>
    <name value="custody-type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Custody type. If missing, then only personal custody types ('H10', 'H11', 'H12') from bound ValueSet are queried."/>
    <type value="code"/>
    <binding>
      <strength value="required"/>
      <valueSet value="https://fhir.ee/ValueSet/hooldusoiguse-liik"/>
    </binding>
  </parameter>
  <parameter>
    <name value="nocache"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Specifies when the operation should ignore the value stored in the cache and should re-request data from the source. By default *false*."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Returns Bundle (with type 'collection') with Observation instances of [EEMPISocialHistoryLegalRelationship](StructureDefinition-ee-mpi-socialhistory-legal-relationship.html) profile. If multiple custody types are found between two persons, then multiple Observation instances for the same patient relationship are returned."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>